Class MyVisualScriptLogicProvider

Inheritance

System.Object

MyVisualScriptLogicProvider

Namespace: Sandbox.Game

Assembly: Sandbox.Game.dll

Syntax

[StaticEventOwner]
public static class MyVisualScriptLogicProvider : Object

Fields

AreaTrigger_Entered

Declaration

public static SingleKeyTriggerEvent AreaTrigger_Entered

Field Value

Type	Description
VRage.Game.VisualScripting.SingleKeyTriggerEvent

AreaTrigger_EntityEntered

Declaration

public static TriggerEventComplex AreaTrigger_EntityEntered

Field Value

Type	Description
VRage.Game.VisualScripting.TriggerEventComplex

AreaTrigger_EntityLeft

Declaration

public static TriggerEventComplex AreaTrigger_EntityLeft

Field Value

Type	Description
VRage.Game.VisualScripting.TriggerEventComplex

AreaTrigger_Left

Declaration

public static SingleKeyTriggerEvent AreaTrigger_Left

Field Value

Type	Description
VRage.Game.VisualScripting.SingleKeyTriggerEvent

BlockBuilt

Declaration

public static BlockEvent BlockBuilt

Field Value

Type	Description
BlockEvent

BlockDamaged

Declaration

public static BlockDamagedEvent BlockDamaged

Field Value

Type	Description
BlockDamagedEvent

BlockDestroyed

Declaration

public static SingleKeyEntityNameGridNameEvent BlockDestroyed

Field Value

Type	Description
SingleKeyEntityNameGridNameEvent

BlockFunctionalityChanged

Declaration

public static BlockFunctionalityChangedEvent BlockFunctionalityChanged

Field Value

Type	Description
BlockFunctionalityChangedEvent

BlockIntegrityChanged

Declaration

public static SingleKeyEntityNameGridNameEvent BlockIntegrityChanged

Field Value

Type	Description
SingleKeyEntityNameGridNameEvent

ButtonPressedEntityName

Declaration

public static ButtonPanelEvent ButtonPressedEntityName

Field Value

Type	Description
ButtonPanelEvent

ButtonPressedTerminalName

Declaration

public static ButtonPanelEvent ButtonPressedTerminalName

Field Value

Type	Description
ButtonPanelEvent

ConnectorStateChanged

Declaration

public static ConnectorStateChangedEvent ConnectorStateChanged

Field Value

Type	Description
ConnectorStateChangedEvent

ContractAbandoned

Declaration

public static ContractAbandonedEvent ContractAbandoned

Field Value

Type	Description
ContractAbandonedEvent

ContractAccepted

Declaration

public static ContractAcceptedEvent ContractAccepted

Field Value

Type	Description
ContractAcceptedEvent

ContractFailed

Declaration

public static ContractFailedEvent ContractFailed

Field Value

Type	Description
ContractFailedEvent

ContractFinished

Declaration

public static ContractFinishedEvent ContractFinished

Field Value

Type	Description
ContractFinishedEvent

CutsceneEnded

Declaration

public static CutsceneEvent CutsceneEnded

Field Value

Type	Description
CutsceneEvent

CutsceneNodeEvent

Declaration

public static CutsceneEvent CutsceneNodeEvent

Field Value

Type	Description
CutsceneEvent

GameIsReady

Declaration

public static bool GameIsReady

Field Value

Type	Description
System.Boolean

GridJumped

Declaration

public static GridJumpedEvent GridJumped

Field Value

Type	Description
GridJumpedEvent

GridPowerGenerationStateChanged

Declaration

public static GridPowerGenerationStateChangedEvent GridPowerGenerationStateChanged

Field Value

Type	Description
GridPowerGenerationStateChangedEvent

GridSpawned

Declaration

public static SingleKeyEntityNameEvent GridSpawned

Field Value

Type	Description
SingleKeyEntityNameEvent

ItemSpawned

Declaration

public static ItemSpawnedEvent ItemSpawned

Field Value

Type	Description
ItemSpawnedEvent

LandingGearUnlocked

Declaration

public static LandingGearUnlockedEvent LandingGearUnlocked

Field Value

Type	Description
LandingGearUnlockedEvent

MatchStateChanged

Declaration

public static MatchStateChangedEvent MatchStateChanged

Field Value

Type	Description
MatchStateChangedEvent

MatchStateEnded

Declaration

public static MatchStateEndedEvent MatchStateEnded

Field Value

Type	Description
MatchStateEndedEvent

MatchStateEnding

Declaration

public static MatchStateEndingEvent MatchStateEnding

Field Value

Type	Description
MatchStateEndingEvent

MatchStateStarted

Declaration

public static MatchStateStartedEvent MatchStateStarted

Field Value

Type	Description
MatchStateStartedEvent

NewItemBuilt

Declaration

public static NewBuiltItemEvent NewItemBuilt

Field Value

Type	Description
NewBuiltItemEvent

NPCDied

Declaration

public static SingleKeyEntityNameEvent NPCDied

Field Value

Type	Description
SingleKeyEntityNameEvent

PlayerConnected

Declaration

public static SingleKeyPlayerEvent PlayerConnected

Field Value

Type	Description
SingleKeyPlayerEvent

PlayerConnectRequest

Declaration

public static SingleKeyPlayerConnectRequestEvent PlayerConnectRequest

Field Value

Type	Description
SingleKeyPlayerConnectRequestEvent

PlayerDied

Declaration

public static SingleKeyPlayerEvent PlayerDied

Field Value

Type	Description
SingleKeyPlayerEvent

PlayerDisconnected

Declaration

public static SingleKeyPlayerEvent PlayerDisconnected

Field Value

Type	Description
SingleKeyPlayerEvent

PlayerDropped

Declaration

public static PlayerItemEvent PlayerDropped

Field Value

Type	Description
PlayerItemEvent

PlayerEnteredCockpit

Declaration

public static DoubleKeyPlayerEvent PlayerEnteredCockpit

Field Value

Type	Description
DoubleKeyPlayerEvent

PlayerHealthRecharging

Declaration

public static PlayerHealthRechargeEvent PlayerHealthRecharging

Field Value

Type	Description
PlayerHealthRechargeEvent

PlayerLeftCockpit

Declaration

public static DoubleKeyPlayerEvent PlayerLeftCockpit

Field Value

Type	Description
DoubleKeyPlayerEvent

PlayerPickedUp

Declaration

public static FloatingObjectPlayerEvent PlayerPickedUp

Field Value

Type	Description
FloatingObjectPlayerEvent

PlayerRequestsRespawn

Declaration

public static SingleKeyPlayerEvent PlayerRequestsRespawn

Field Value

Type	Description
SingleKeyPlayerEvent

PlayerRespawnRequest

Declaration

public static SingleKeyPlayerEvent PlayerRespawnRequest

Field Value

Type	Description
SingleKeyPlayerEvent

PlayerSpawned

Declaration

public static SingleKeyPlayerEvent PlayerSpawned

Field Value

Type	Description
SingleKeyPlayerEvent

PlayerSuitRecharging

Declaration

public static PlayerSuitRechargeEvent PlayerSuitRecharging

Field Value

Type	Description
PlayerSuitRechargeEvent

PrefabSpawned

Declaration

public static SingleKeyEntityNameEvent PrefabSpawned

Field Value

Type	Description
SingleKeyEntityNameEvent

PrefabSpawnedDetailed

Declaration

public static PrefabSpawnedEvent PrefabSpawnedDetailed

Field Value

Type	Description
PrefabSpawnedEvent

RemoteControlChanged

Declaration

public static RemoteControlChangedEvent RemoteControlChanged

Field Value

Type	Description
RemoteControlChangedEvent

RespawnShipSpawned

Declaration

public static RespawnShipSpawnedEvent RespawnShipSpawned

Field Value

Type	Description
RespawnShipSpawnedEvent

RoomFullyPressurized

Declaration

public static RoomFullyPressurizedEvent RoomFullyPressurized

Field Value

Type	Description
RoomFullyPressurizedEvent

ScreenAdded

Declaration

public static ScreenManagerEvent ScreenAdded

Field Value

Type	Description
ScreenManagerEvent

ScreenRemoved

Declaration

public static ScreenManagerEvent ScreenRemoved

Field Value

Type	Description
ScreenManagerEvent

ShipDrillCollected

Declaration

public static ShipDrillCollectedEvent ShipDrillCollected

Field Value

Type	Description
ShipDrillCollectedEvent

TeamBalancerPlayerSorted

Declaration

public static TeamBalancerSortEvent TeamBalancerPlayerSorted

Field Value

Type	Description
TeamBalancerSortEvent

TimerBlockTriggered

Declaration

public static SingleKeyEntityNameGridNameEvent TimerBlockTriggered

Field Value

Type	Description
SingleKeyEntityNameGridNameEvent

TimerBlockTriggeredEntityName

Declaration

public static SingleKeyEntityNameGridNameEvent TimerBlockTriggeredEntityName

Field Value

Type	Description
SingleKeyEntityNameGridNameEvent

ToolbarItemChanged

Declaration

public static ToolbarItemChangedEvent ToolbarItemChanged

Field Value

Type	Description
ToolbarItemChangedEvent

ToolEquipped

Declaration

public static ToolEquipedEvent ToolEquipped

Field Value

Type	Description
ToolEquipedEvent

WeaponBlockActivated

Declaration

public static WeaponBlockActivatedEvent WeaponBlockActivated

Field Value

Type	Description
WeaponBlockActivatedEvent

Methods

AddAcquisitionContract(Int64, Int32, Int32, Int32, Int64, MyDefinitionId, Int32, out Int64)

Declaration

[VisualScriptingMiscData("Contract", "Create and add new Acquisition contract. Returns true if contract creation was successful. Id of newly created contract is stored in out variable id. End block is contract block where items of type 'itemType' in quantity 'itemAmount' are to be delivered.", -10510688)]
[VisualScriptingMember(true, false)]
public static bool AddAcquisitionContract(long startBlockId, int moneyReward, int collateral, int duration, long endBlockId, MyDefinitionId itemType, int itemAmount, out long id)

Parameters

Type	Name	Description
System.Int64	startBlockId
System.Int32	moneyReward
System.Int32	collateral
System.Int32	duration
System.Int64	endBlockId
MyDefinitionId	itemType
System.Int32	itemAmount
System.Int64	id

Returns

Type	Description
System.Boolean

AddBountyContract(Int64, Int32, Int32, Int32, Int64, out Int64)

Declaration

[VisualScriptingMiscData("Contract", "Create and add new Bounty contract. Returns true if contract creation was successful. Id of newly created contract is stored in out variable id.", -10510688)]
[VisualScriptingMember(true, false)]
public static bool AddBountyContract(long startBlockId, int moneyReward, int collateral, int duration, long targetIdentityId, out long id)

Parameters

Type	Name	Description
System.Int64	startBlockId
System.Int32	moneyReward
System.Int32	collateral
System.Int32	duration
System.Int64	targetIdentityId
System.Int64	id

Returns

Type	Description
System.Boolean

AddColumn(String, String, Single, String, MyGuiDrawAlignEnum, MyGuiDrawAlignEnum, Int64)

Declaration

[VisualScriptingMiscData("Board screen", "Add column to board screen.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AddColumn(string boardId, string columnId, float width, string headerText, MyGuiDrawAlignEnum headerDrawAlign, MyGuiDrawAlignEnum columnDrawAlign, long playerId = -1L)

Parameters

Type	Name	Description
System.String	boardId
System.String	columnId
System.Single	width
System.String	headerText
MyGuiDrawAlignEnum	headerDrawAlign
MyGuiDrawAlignEnum	columnDrawAlign
System.Int64	playerId

AddEscortContract(Int64, Int32, Int32, Int32, Vector3D, Vector3D, Int64, out Int64)

Declaration

[VisualScriptingMiscData("Contract", "Create and add new Escort contract. Returns true if contract creation was successful. Id of newly created contract is stored in out variable id. Escort ship will start from 'start' flying towards the 'end'. Escorted ship will be owned by 'ownerIdentityId'", -10510688)]
[VisualScriptingMember(true, false)]
public static bool AddEscortContract(long startBlockId, int moneyReward, int collateral, int duration, Vector3D start, Vector3D end, long ownerIdentityId, out long id)

Parameters

Type	Name	Description
System.Int64	startBlockId
System.Int32	moneyReward
System.Int32	collateral
System.Int32	duration
Vector3D	start
Vector3D	end
System.Int64	ownerIdentityId
System.Int64	id

Returns

Type	Description
System.Boolean

AddGPS(String, String, Vector3D, Color, Int32, Int64)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Adds GPS for specified player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AddGPS(string name, string description, Vector3D position, Color GPSColor, int disappearsInS = 0, long playerId = -1L)

Parameters

Type	Name	Description
System.String	name
System.String	description
Vector3D	position
Color	GPSColor
System.Int32	disappearsInS
System.Int64	playerId

AddGPSForAll(String, String, Vector3D, Color, Int32)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Adds GPS for all players.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AddGPSForAll(string name, string description, Vector3D position, Color GPSColor, int disappearsInS = 0)

Parameters

Type	Name	Description
System.String	name
System.String	description
Vector3D	position
Color	GPSColor
System.Int32	disappearsInS

AddGPSObjective(String, String, Vector3D, Color, Int32, Int64)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Adds GPS for specified player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AddGPSObjective(string name, string description, Vector3D position, Color GPSColor, int disappearsInS = 0, long playerId = -1L)

Parameters

Type	Name	Description
System.String	name
System.String	description
Vector3D	position
Color	GPSColor
System.Int32	disappearsInS
System.Int64	playerId

AddGPSObjectiveForAll(String, String, Vector3D, Color, Int32)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Adds GPS for all players.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AddGPSObjectiveForAll(string name, string description, Vector3D position, Color GPSColor, int disappearsInS = 0)

Parameters

Type	Name	Description
System.String	name
System.String	description
Vector3D	position
Color	GPSColor
System.Int32	disappearsInS

AddGPSObjectiveToEntity(String, String, String, Color, Int64)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Creates GPS and attach it to entity for local player only.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AddGPSObjectiveToEntity(string entityName, string GPSName, string GPSDescription, Color GPSColor, long playerId = -1L)

Parameters

Type	Name	Description
System.String	entityName
System.String	GPSName
System.String	GPSDescription
Color	GPSColor
System.Int64	playerId

AddGPSObjectiveToEntityForAll(String, String, String, Color)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Creates GPS and attach it to entity for all players", -10510688)]
[VisualScriptingMember(true, false)]
public static void AddGPSObjectiveToEntityForAll(string entityName, string GPSName, string GPSDescription, Color GPSColor)

Parameters

Type	Name	Description
System.String	entityName
System.String	GPSName
System.String	GPSDescription
Color	GPSColor

AddGPSToEntity(String, String, String, Color, Int64)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Creates GPS and attach it to entity for local player only.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AddGPSToEntity(string entityName, string GPSName, string GPSDescription, Color GPSColor, long playerId = -1L)

Parameters

Type	Name	Description
System.String	entityName
System.String	GPSName
System.String	GPSDescription
Color	GPSColor
System.Int64	playerId

AddGPSToEntityForAll(String, String, String, Color)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Creates GPS and attach it to entity for all players", -10510688)]
[VisualScriptingMember(true, false)]
public static void AddGPSToEntityForAll(string entityName, string GPSName, string GPSDescription, Color GPSColor)

Parameters

Type	Name	Description
System.String	entityName
System.String	GPSName
System.String	GPSDescription
Color	GPSColor

AddGridToTargetList(String, String)

Declaration

[VisualScriptingMiscData("AI", "Adds grid with specific name into drone's targets.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AddGridToTargetList(string gridName, string targetGridname)

Parameters

Type	Name	Description
System.String	gridName
System.String	targetGridname

AddHaulingContract(Int64, Int32, Int32, Int32, Int64, out Int64)

Declaration

[VisualScriptingMiscData("Contract", "Create and add new Hauling contract. Returns true if contract creation was successful. Id of newly created contract is stored in out variable id. End block is contract block where package is to be delivered.", -10510688)]
[VisualScriptingMember(true, false)]
public static bool AddHaulingContract(long startBlockId, int moneyReward, int collateral, int duration, long endBlockId, out long id)

Parameters

Type	Name	Description
System.Int64	startBlockId
System.Int32	moneyReward
System.Int32	collateral
System.Int32	duration
System.Int64	endBlockId
System.Int64	id

Returns

Type	Description
System.Boolean

AddMatchStateRemainingDuration(Single)

Declaration

[VisualScriptingMiscData("Other", "Get remaining time of the current match state. Time is in minutes. Positive value will lenghten the phase, negative will shorten it. If remaining duration becomes lower or equal to zero, next match phase will start", -10510688)]
[VisualScriptingMember(true, false)]
public static void AddMatchStateRemainingDuration(float time)

Parameters

Type	Name	Description
System.Single	time

AddNotification(String, String, Int64)

Declaration

[VisualScriptingMiscData("Notifications", "Adds a new notification for the specific player and returns if of the notification. Returns -1 if no player corresponds to 'playerId'. For 'playerId' equal to 0 use local player.", -10510688)]
[VisualScriptingMember(true, false)]
public static int AddNotification(string message, string font = "White", long playerId = 0L)

Parameters

Type	Name	Description
System.String	message
System.String	font
System.Int64	playerId

Returns

Type	Description
System.Int32

AddNotificationLocal(String, String, Int32)

Declaration

public static void AddNotificationLocal(string message, string font, int notificationId)

Parameters

Type	Name	Description
System.String	message
System.String	font
System.Int32	notificationId

AddQuestlogDetail(String, Boolean, Boolean, Int64)

Declaration

[VisualScriptingMiscData("Questlog", "Sets detail of the quest for the specified player.", -10510688)]
[VisualScriptingMember(true, false)]
public static int AddQuestlogDetail(string questDetailRow = "", bool completePrevious = true, bool useTyping = true, long playerId = -1L)

Parameters

Type	Name	Description
System.String	questDetailRow
System.Boolean	completePrevious
System.Boolean	useTyping
System.Int64	playerId

Returns

Type	Description
System.Int32

AddQuestlogDetailLocal(String, Boolean, Boolean, Int64)

Declaration

public static void AddQuestlogDetailLocal(string questDetailRow = "", bool completePrevious = true, bool useTyping = true, long playerId = -1L)

Parameters

Type	Name	Description
System.String	questDetailRow
System.Boolean	completePrevious
System.Boolean	useTyping
System.Int64	playerId

AddQuestlogObjective(String, Boolean, Boolean, Int64)

Declaration

[VisualScriptingMiscData("Questlog", "Sets objective of the quest for the specified player.", -10510688)]
[VisualScriptingMember(true, false)]
public static int AddQuestlogObjective(string questDetailRow = "", bool completePrevious = true, bool useTyping = true, long playerId = -1L)

Parameters

Type	Name	Description
System.String	questDetailRow
System.Boolean	completePrevious
System.Boolean	useTyping
System.Int64	playerId

Returns

Type	Description
System.Int32

AddQuestlogObjectiveLocal(String, Boolean, Boolean, Int64)

Declaration

public static void AddQuestlogObjectiveLocal(string questDetailRow = "", bool completePrevious = true, bool useTyping = true, long playerId = -1L)

Parameters

Type	Name	Description
System.String	questDetailRow
System.Boolean	completePrevious
System.Boolean	useTyping
System.Int64	playerId

AddRepairContract(Int64, Int32, Int32, Int32, Int64, out Int64)

Declaration

[VisualScriptingMiscData("Contract", "Create and add new Repair contract. Returns true if contract creation was successful. Id of newly created contract is stored in out variable id.", -10510688)]
[VisualScriptingMember(true, false)]
public static bool AddRepairContract(long startBlockId, int moneyReward, int collateral, int duration, long targetGridId, out long id)

Parameters

Type	Name	Description
System.Int64	startBlockId
System.Int32	moneyReward
System.Int32	collateral
System.Int32	duration
System.Int64	targetGridId
System.Int64	id

Returns

Type	Description
System.Boolean

AddRow(String, String, Int64)

Declaration

[VisualScriptingMiscData("Board screen", "Add row to board screen.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AddRow(string boardId, string rowId, long playerId = -1L)

Parameters

Type	Name	Description
System.String	boardId
System.String	rowId
System.Int64	playerId

AddSearchContract(Int64, Int32, Int32, Int32, Int64, Double, out Int64)

Declaration

[VisualScriptingMiscData("Contract", "Create and add new Search contract. Returns true if contract creation was successful. Id of newly created contract is stored in out variable id. 'targetGridId' is id of grid that will be searched and 'searchRadius' is radius of sphere around searched grid where GPS will be randomly placed in", -10510688)]
[VisualScriptingMember(true, false)]
public static bool AddSearchContract(long startBlockId, int moneyReward, int collateral, int duration, long targetGridId, double searchRadius, out long id)

Parameters

Type	Name	Description
System.Int64	startBlockId
System.Int32	moneyReward
System.Int32	collateral
System.Int32	duration
System.Int64	targetGridId
System.Double	searchRadius
System.Int64	id

Returns

Type	Description
System.Boolean

AddToInventory(String, MyDefinitionId, Int32)

Declaration

[VisualScriptingMiscData("Entity", "Adds item defined by id in specific quantity into inventory of entity.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AddToInventory(string entityname, MyDefinitionId itemId, int amount = 1)

Parameters

Type	Name	Description
System.String	entityname
MyDefinitionId	itemId
System.Int32	amount

AddToInventoryFloat(String, MyDefinitionId, Single)

Declaration

[VisualScriptingMiscData("Entity", "Adds item defined by id in specific quantity into inventory of entity.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AddToInventoryFloat(string entityname, MyDefinitionId itemId, float amount = 1F)

Parameters

Type	Name	Description
System.String	entityname
MyDefinitionId	itemId
System.Single	amount

AddToPlayersInventory(Int64, MyDefinitionId, Int32)

Declaration

[VisualScriptingMiscData("Player", "Adds the specified item to the player's inventory.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AddToPlayersInventory(long playerId = 0L, MyDefinitionId itemId = null, int amount = 1)

Parameters

Type	Name	Description
System.Int64	playerId
MyDefinitionId	itemId
System.Int32	amount

AdvanceMatchState()

Declaration

[VisualScriptingMiscData("Other", "Immediately progress match into next phase. Returns name of new state.", -10510688)]
[VisualScriptingMember(true, false)]
public static string AdvanceMatchState()

Returns

Type	Description
System.String

AreEssentialGoodbotHintsDone()

Declaration

[VisualScriptingMiscData("Questlog", "Returns true if all essential hints have been completed.", -10510688)]
[VisualScriptingMember(true, false)]
public static bool AreEssentialGoodbotHintsDone()

Returns

Type	Description
System.Boolean

AreFactionsEnemies(String, String)

Declaration

[VisualScriptingMiscData("Factions", "Returns true if specified two factions are enemies.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool AreFactionsEnemies(string firstFactionTag, string secondFactionTag)

Parameters

Type	Name	Description
System.String	firstFactionTag
System.String	secondFactionTag

Returns

Type	Description
System.Boolean

AutopilotActivate(String, FlightMode, Single, Boolean, Boolean)

Declaration

[VisualScriptingMiscData("AI", "Activates autopilot of specific drone and set all required parameters. Waypoints will not be cleared.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AutopilotActivate(string entityName, FlightMode mode, float speedLimit = 120F, bool collisionAvoidance = true, bool precisionMode = false)

Parameters

Type	Name	Description
System.String	entityName
FlightMode	mode
System.Single	speedLimit
System.Boolean	collisionAvoidance
System.Boolean	precisionMode

AutopilotAddWaypoint(String, Vector3D, String)

Declaration

[VisualScriptingMiscData("AI", "Adds new waypoint for specific drone.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AutopilotAddWaypoint(string entityName, Vector3D position, string waypointName = "Waypoint")

Parameters

Type	Name	Description
System.String	entityName
Vector3D	position
System.String	waypointName

AutopilotClearWaypoints(String)

Declaration

[VisualScriptingMiscData("AI", "Clears all waypoints of specific drone.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AutopilotClearWaypoints(string entityName)

Parameters

Type	Name	Description
System.String	entityName

AutopilotEnabled(String, Boolean)

Declaration

[VisualScriptingMiscData("AI", "Enables/disables autopilot of specific drone", -10510688)]
[VisualScriptingMember(true, false)]
public static void AutopilotEnabled(string entityName, bool enabled = true)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	enabled

AutopilotGetCurrentWaypoint(String, out String)

Declaration

[VisualScriptingMiscData("AI", "Gets position of curret waypoint of specific drone. If current waypoint exists, returns it position and 'waypointName' will be name of the waypoint. If waypoint does not exists, return current position and 'waypointName' will be empty string.", -10510688)]
[VisualScriptingMember(false, false)]
public static Vector3D AutopilotGetCurrentWaypoint(string entityName, out string waypointName)

Parameters

Type	Name	Description
System.String	entityName
System.String	waypointName

Returns

Type	Description
Vector3D

AutopilotGoToPosition(String, Vector3D, String, Single, Boolean, Boolean)

Declaration

[VisualScriptingMiscData("AI", "Enables drone's autopilot, sets it to one-way go to waypoint and adds that one waypoint. All previous waypoints will be cleared.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AutopilotGoToPosition(string entityName, Vector3D position, string waypointName = "Waypoint", float speedLimit = 120F, bool collisionAvoidance = true, bool precisionMode = false)

Parameters

Type	Name	Description
System.String	entityName
Vector3D	position
System.String	waypointName
System.Single	speedLimit
System.Boolean	collisionAvoidance
System.Boolean	precisionMode

AutopilotSetWaypoints(String, List<Vector3D>, String)

Declaration

[VisualScriptingMiscData("AI", "Adds list of waypoints to specific drone. All waypoints will be called 'waypointName' followed by space and number. (given by order, starts with 1)", -10510688)]
[VisualScriptingMember(true, false)]
public static void AutopilotSetWaypoints(string entityName, List<Vector3D> positions, string waypointName = "Waypoint")

Parameters

Type	Name	Description
System.String	entityName
System.Collections.Generic.List<Vector3D>	positions
System.String	waypointName

AutopilotSkipCurrentWaypoint(String)

Declaration

[VisualScriptingMiscData("AI", "Orders drone to immediately skip current waypoint and go directly to the next one.", -10510688)]
[VisualScriptingMember(true, false)]
public static void AutopilotSkipCurrentWaypoint(string entityName)

Parameters

Type	Name	Description
System.String	entityName

CancelStoreItem(String, Int64)

Declaration

[VisualScriptingMiscData("Store", "Cancels listed item in specified store.", -10510688)]
[VisualScriptingMember(true, false)]
public static bool CancelStoreItem(string storeEntityName, long id)

Parameters

Type	Name	Description
System.String	storeEntityName
System.Int64	id

Returns

Type	Description
System.Boolean

ChangeDoorState(Int64, Boolean)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Sets specific doors to open/close state. (Doors, SlidingDoors, AirtightDoors)", -10510688)]
[VisualScriptingMember(true, false)]
public static void ChangeDoorState(long doorId, bool open = true)

Parameters

Type	Name	Description
System.Int64	doorId
System.Boolean	open

ChangeDoorState(String, Boolean)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Sets specific doors to open/close state. (Doors, SlidingDoors, AirtightDoors)", -10510688)]
[VisualScriptingMember(true, false)]
public static void ChangeDoorState(string doorBlockName, bool open = true)

Parameters

Type	Name	Description
System.String	doorBlockName
System.Boolean	open

ChangeOwner(String, Int64, Boolean, Boolean)

Declaration

[VisualScriptingMiscData("Entity", "Changes ownership of a specific block (if entity is block) or ownership of all functional blocks (if entity is grid) to specific player and modify its/theirs share settings.", -10510688)]
[VisualScriptingMember(true, false)]
public static bool ChangeOwner(string entityName, long playerId = 0L, bool factionShare = false, bool allShare = false)

Parameters

Type	Name	Description
System.String	entityName
System.Int64	playerId
System.Boolean	factionShare
System.Boolean	allShare

Returns

Type	Description
System.Boolean

ClearAllToolbarSlots(Int64)

Declaration

[VisualScriptingMiscData("Toolbar", "Clears all toolbar slots for the specified player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ClearAllToolbarSlots(long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	playerId

ClearAllToolbarSlotsLocal(Int64)

Declaration

public static void ClearAllToolbarSlotsLocal(long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	playerId

ClearNotificationLocal(Int64)

Declaration

public static void ClearNotificationLocal(long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	playerId

ClearNotifications(Int64)

Declaration

[VisualScriptingMiscData("Notifications", "Clears all added notifications.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ClearNotifications(long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	playerId

ClearToolbarSlot(Int32, Int64)

Declaration

[VisualScriptingMiscData("Toolbar", "Clears the toolbar slot for the player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ClearToolbarSlot(int slot, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	slot
System.Int64	playerId

ClearToolbarSlotLocal(Int32, Int64)

Declaration

public static void ClearToolbarSlotLocal(int slot, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	slot
System.Int64	playerId

CockpitGetPilotId(String, out Boolean)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Returns identity Id of player occupying cockpit or 0, if no one is in. ", -10510688)]
[VisualScriptingMember(false, false)]
public static long CockpitGetPilotId(string cockpitName, out bool occupied)

Parameters

Type	Name	Description
System.String	cockpitName
System.Boolean	occupied

Returns

Type	Description
System.Int64

CockpitInsertPilot(String, Boolean, Int64)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Forces player into specific Cockpit.", -10510688)]
[VisualScriptingMember(true, false)]
public static void CockpitInsertPilot(string cockpitName, bool keepOriginalPlayerPosition = true, long playerId = 0L)

Parameters

Type	Name	Description
System.String	cockpitName
System.Boolean	keepOriginalPlayerPosition
System.Int64	playerId

CockpitRemovePilot(String)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Removes pilot from specific Cockpit.", -10510688)]
[VisualScriptingMember(true, false)]
public static void CockpitRemovePilot(string cockpitName)

Parameters

Type	Name	Description
System.String	cockpitName

ColorAllGridBlocks(String, Color, Boolean)

Declaration

[VisualScriptingMiscData("Grid", "Colors all blocks of specific grid.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ColorAllGridBlocks(string gridName, Color color, bool playSound = true)

Parameters

Type	Name	Description
System.String	gridName
Color	color
System.Boolean	playSound

ColorAndSkinBlock(String, Color, String)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Sets color and skin of specific block.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ColorAndSkinBlock(string blockName, Color color, string skin)

Parameters

Type	Name	Description
System.String	blockName
Color	color
System.String	skin

ColorBlock(String, Color)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Sets color of specific block.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ColorBlock(string blockName, Color color)

Parameters

Type	Name	Description
System.String	blockName
Color	color

CreateAreaTriggerOnEntity(String, Single, String)

Declaration

[VisualScriptingMiscData("Triggers", "Creates area trigger at the position of specified entity.", -10510688)]
[VisualScriptingMember(true, false)]
public static void CreateAreaTriggerOnEntity(string entityName, float radius, string name)

Parameters

Type	Name	Description
System.String	entityName
System.Single	radius
System.String	name

CreateAreaTriggerOnPosition(Vector3D, Single, String)

Declaration

[VisualScriptingMiscData("Triggers", "Creates area trigger at the position.", -10510688)]
[VisualScriptingMember(true, false)]
public static long CreateAreaTriggerOnPosition(Vector3D position, float radius, string name)

Parameters

Type	Name	Description
Vector3D	position
System.Single	radius
System.String	name

Returns

Type	Description
System.Int64

CreateAreaTriggerRelativeToEntity(Vector3D, String, Single, String)

Declaration

[VisualScriptingMiscData("Triggers", "Creates area trigger at the relative position to the specified entity.", -10510688)]
[VisualScriptingMember(true, false)]
public static void CreateAreaTriggerRelativeToEntity(Vector3D position, string entityName, float radius, string name)

Parameters

Type	Name	Description
Vector3D	position
System.String	entityName
System.Single	radius
System.String	name

CreateBoardScreen(String, Single, Single, Single, Single, Int64)

Declaration

[VisualScriptingMiscData("Board screen", "Create board screen on specific coordinates. PlayerId -1 stands for all players, 0 for local player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void CreateBoardScreen(string boardId, float normalizedPosX, float normalizedPosY, float normalizedSizeX, float normalizedSizeY, long playerId = -1L)

Parameters

Type	Name	Description
System.String	boardId
System.Single	normalizedPosX
System.Single	normalizedPosY
System.Single	normalizedSizeX
System.Single	normalizedSizeY
System.Int64	playerId

CreateExplosion(Vector3D, Single, Int32)

Declaration

[VisualScriptingMiscData("Effects", "Creates explosion at specific point with specified radius, causing damage to everything in range.", -10510688)]
[VisualScriptingMember(true, false)]
public static void CreateExplosion(Vector3D position, float radius, int damage = 5000)

Parameters

Type	Name	Description
Vector3D	position
System.Single	radius
System.Int32	damage

CreateFaction(Int64, String, String, String, String)

Declaration

[VisualScriptingMiscData("Factions", "Creates new faction.", -10510688)]
[VisualScriptingMember(true, false)]
public static void CreateFaction(long founderId, string factionTag, string factionName = "", string factionDescription = "", string factionPrivateText = "")

Parameters

Type	Name	Description
System.Int64	founderId
System.String	factionTag
System.String	factionName
System.String	factionDescription
System.String	factionPrivateText

CreateLightning(Vector3D)

Declaration

[VisualScriptingMiscData("Environment", "Creates lightning on exact position", -10510688)]
[VisualScriptingMember(true, false)]
public static void CreateLightning(Vector3D position)

Parameters

Type	Name	Description
Vector3D	position

CreateLightning(Vector3D, Single, Byte, Int16, Single, Int16, Int32)

Declaration

[VisualScriptingMiscData("Environment", "Summons lightning on a position", -10510688)]
[VisualScriptingMember(true, false)]
public static void CreateLightning(Vector3D position, float boltLength, byte boltParts, short boltVariation, float boltRadius, short maxLife, int damage)

Parameters

Type	Name	Description
Vector3D	position
System.Single	boltLength
System.Byte	boltParts
System.Int16	boltVariation
System.Single	boltRadius
System.Int16	maxLife
System.Int32	damage

CreateLocalBlueprint(String, String, String)

Declaration

[VisualScriptingMiscData("Grid", "Creates local blueprint for player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void CreateLocalBlueprint(string gridName, string blueprintName, string blueprintDisplayName = null)

Parameters

Type	Name	Description
System.String	gridName
System.String	blueprintName
System.String	blueprintDisplayName

CreateParticleEffectAtEntity(String, String)

Declaration

[VisualScriptingMiscData("Effects", "Creates specific particle effect at entity.", -10510688)]
[VisualScriptingMember(true, false)]
public static void CreateParticleEffectAtEntity(string effectName, string entityName)

Parameters

Type	Name	Description
System.String	effectName
System.String	entityName

CreateParticleEffectAtPosition(String, Vector3D)

Declaration

[VisualScriptingMiscData("Effects", "Creates specific particle effect at position.", -10510688)]
[VisualScriptingMember(true, false)]
public static void CreateParticleEffectAtPosition(string effectName, Vector3D position)

Parameters

Type	Name	Description
System.String	effectName
Vector3D	position

CreateSoundEmitterAtEntity(String, String)

Declaration

[VisualScriptingMiscData("Audio", "Creates new 3D sound emitter at entity.", -10510688)]
[VisualScriptingMember(true, false)]
public static void CreateSoundEmitterAtEntity([Nullable] string newEmitterId, string entityName)

Parameters

Type	Name	Description
System.String	newEmitterId
System.String	entityName

CreateSoundEmitterAtEntityLocal(String, String)

Declaration

public static void CreateSoundEmitterAtEntityLocal(string newEmitterId, string entityName)

Parameters

Type	Name	Description
System.String	newEmitterId
System.String	entityName

CreateSoundEmitterAtPosition(String, Vector3D)

Declaration

[VisualScriptingMiscData("Audio", "Creates new 3D sound emitter at specific location.", -10510688)]
[VisualScriptingMember(true, false)]
public static void CreateSoundEmitterAtPosition([Nullable] string newEmitterId, Vector3D position)

Parameters

Type	Name	Description
System.String	newEmitterId
Vector3D	position

CreateSoundEmitterAtPositionLocal(String, Vector3D)

Declaration

public static void CreateSoundEmitterAtPositionLocal([Nullable] string newEmitterId, Vector3D position)

Parameters

Type	Name	Description
System.String	newEmitterId
Vector3D	position

CreateUIString(Int64, String, Single, Single, Single, String, MyGuiDrawAlignEnum, Int64)

Declaration

[VisualScriptingMiscData("UIString", "Create UI string on specific coordinates. PlayerId -1 stands for all players, 0 for local player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void CreateUIString(long id, string text, float normalizedXPos, float normalizedYPos, float scale = 1F, string font = "White", MyGuiDrawAlignEnum drawAlign, long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	id
System.String	text
System.Single	normalizedXPos
System.Single	normalizedYPos
System.Single	scale
System.String	font
MyGuiDrawAlignEnum	drawAlign
System.Int64	playerId

CustomRespawnRequest(Int64)

Declaration

public static void CustomRespawnRequest(long playerId)

Parameters

Type	Name	Description
System.Int64	playerId

DamageBlock(String, Single, Int64)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Applies damage to specific block from specific player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void DamageBlock(string entityName, float damage = 0F, long damageOwner = 0L)

Parameters

Type	Name	Description
System.String	entityName
System.Single	damage
System.Int64	damageOwner

DefinitionIdMatch(String, String, String, String)

Declaration

[VisualScriptingMiscData("Definitions", "Returns true if the type id and subtype id match.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool DefinitionIdMatch(string typeId, string subtypeId, string matchTypeId, string matchSubtypeId)

Parameters

Type	Name	Description
System.String	typeId
System.String	subtypeId
System.String	matchTypeId
System.String	matchSubtypeId

Returns

Type	Description
System.Boolean

DisableBlock(String)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Disables functional block.", -10510688)]
[VisualScriptingMember(true, false)]
public static void DisableBlock(string blockName)

Parameters

Type	Name	Description
System.String	blockName

DisconnectPlayer(UInt64)

Declaration

[VisualScriptingMember(true, false)]
[VisualScriptingMiscData("Gameplay", "Disconnect player.", -10510688)]
public static void DisconnectPlayer(ulong steamId)

Parameters

Type	Name	Description
System.UInt64	steamId

DisplayCongratulationScreen(Int32, Int64)

Declaration

[VisualScriptingMiscData("Notifications", "Display congratulation screen to playet/s. Use MessageId to select which message should be shown. If player id is 1-, show to all. If it is 0, show to local player. Else it will be used as player identity id.", -10510688)]
[VisualScriptingMember(true, false)]
public static void DisplayCongratulationScreen(int congratulationMessageId, long playerId)

Parameters

Type	Name	Description
System.Int32	congratulationMessageId
System.Int64	playerId

DroneGetCurrentAIBehavior(String)

Declaration

[VisualScriptingMiscData("AI", "Gets AI behavior of specific drone. Returns empty string if drone lacks remote or AI behavior.", -10510688)]
[VisualScriptingMember(false, false)]
public static string DroneGetCurrentAIBehavior(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.String

DroneGetSpeedLimit(String)

Declaration

[VisualScriptingMiscData("AI", "Gets speed limit of specific drone.", -10510688)]
[VisualScriptingMember(false, false)]
public static float DroneGetSpeedLimit(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.Single

DroneGetTargetsCount(String)

Declaration

[VisualScriptingMiscData("AI", "Gets count of targets for specific drone. Returns -1 if drone lacks remote or AI behavior.", -10510688)]
[VisualScriptingMember(false, false)]
public static int DroneGetTargetsCount(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.Int32

DroneGetWaypointCount(String)

Declaration

[VisualScriptingMiscData("AI", "Gets number of waypoints for specific drone. Returns -1 if drone has no remote or AI behavior.", -10510688)]
[VisualScriptingMember(false, false)]
public static int DroneGetWaypointCount(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.Int32

DroneHasAI(String)

Declaration

[VisualScriptingMiscData("AI", "Returns true if specific drone has both remote and AI behavior, false otherwise.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool DroneHasAI(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.Boolean

DroneIsInAmbushMode(String)

Declaration

[VisualScriptingMiscData("AI", "Returns true if drone is in ambush mode, false otherwise.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool DroneIsInAmbushMode(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.Boolean

DroneIsOperational(String)

Declaration

[VisualScriptingMiscData("AI", "Returns true if specific drone has both working remoteand have operational AI behavior, false otherwise.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool DroneIsOperational(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.Boolean

DroneProcessTargets(List<MyEntity>)

Declaration

public static List<DroneTarget> DroneProcessTargets(List<MyEntity> targets)

Parameters

Type	Name	Description
System.Collections.Generic.List<MyEntity>	targets

Returns

Type	Description
System.Collections.Generic.List<Sandbox.Game.GameSystems.DroneTarget>

DroneSetAmbushMode(String, Boolean)

Declaration

[VisualScriptingMiscData("AI", "Activates/deactivates ambush mode for specific drone.", -10510688)]
[VisualScriptingMember(true, false)]
public static void DroneSetAmbushMode(string entityName, bool ambushModeOn = true)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	ambushModeOn

DroneSetCollisionAvoidance(String, Boolean)

Declaration

[VisualScriptingMiscData("AI", "Enables/disables collision avoidance for specific drone.", -10510688)]
[VisualScriptingMember(true, false)]
public static void DroneSetCollisionAvoidance(string entityName, bool collisionAvoidance = true)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	collisionAvoidance

DroneSetPlayerPriority(String, Int32)

Declaration

[VisualScriptingMiscData("AI", "Sets player targeting priority of specific drone. (All player controlled entities will be considered a target if priority is greater than 0)", -10510688)]
[VisualScriptingMember(true, false)]
public static void DroneSetPlayerPriority(string entityName, int priority)

Parameters

Type	Name	Description
System.String	entityName
System.Int32	priority

DroneSetPrioritizationStyle(String, TargetPrioritization)

Declaration

[VisualScriptingMiscData("AI", "Sets target prioritization for specific drone.", -10510688)]
[VisualScriptingMember(true, false)]
public static void DroneSetPrioritizationStyle(string entityName, TargetPrioritization style)

Parameters

Type	Name	Description
System.String	entityName
VRage.Game.ObjectBuilders.AI.TargetPrioritization	style

DroneSetRetreatPosition(String, Vector3D)

Declaration

[VisualScriptingMiscData("AI", "Sets origin point of specific drone. (Once non-kamikaze drone has no weapons, it will retreat to that point.)", -10510688)]
[VisualScriptingMember(true, false)]
public static void DroneSetRetreatPosition(string entityName, Vector3D position)

Parameters

Type	Name	Description
System.String	entityName
Vector3D	position

DroneSetRotateToTarget(String, Boolean)

Declaration

[VisualScriptingMiscData("AI", "Enables/disables if drone should rotate toward it's target.", -10510688)]
[VisualScriptingMember(true, false)]
public static void DroneSetRotateToTarget(string entityName, bool rotateToTarget = true)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	rotateToTarget

DroneSetSpeedLimit(String, Single)

Declaration

[VisualScriptingMiscData("AI", "Sets maximum speed limit of specific drone.", -10510688)]
[VisualScriptingMember(true, false)]
public static void DroneSetSpeedLimit(string entityName, float speedLimit = 100F)

Parameters

Type	Name	Description
System.String	entityName
System.Single	speedLimit

DroneSetTarget(String, MyEntity)

Declaration

[VisualScriptingMiscData("AI", "Sets current target of drone to specific entity.", -10510688)]
[VisualScriptingMember(true, false)]
public static void DroneSetTarget(string entityName, MyEntity target)

Parameters

Type	Name	Description
System.String	entityName
MyEntity	target

DroneTargetAdd(String, MyEntity, Int32)

Declaration

[VisualScriptingMiscData("AI", "Adds specific entity into targets of specific drone. Priority specifies order in which targets will be dealt with (higher is more important).", -10510688)]
[VisualScriptingMember(true, false)]
public static void DroneTargetAdd(string entityName, MyEntity target, int priority = 1)

Parameters

Type	Name	Description
System.String	entityName
MyEntity	target
System.Int32	priority

DroneTargetClear(String)

Declaration

[VisualScriptingMiscData("AI", "Clears all targets of specific drone.", -10510688)]
[VisualScriptingMember(true, false)]
public static void DroneTargetClear(string entityName)

Parameters

Type	Name	Description
System.String	entityName

DroneTargetLoseCurrent(String)

Declaration

[VisualScriptingMiscData("AI", "Sets current target of specific drone to none.", -10510688)]
[VisualScriptingMember(true, false)]
public static void DroneTargetLoseCurrent(string entityName)

Parameters

Type	Name	Description
System.String	entityName

DroneTargetRemove(String, MyEntity)

Declaration

[VisualScriptingMiscData("AI", "Removes specific entity from drone's targets", -10510688)]
[VisualScriptingMember(true, false)]
public static void DroneTargetRemove(string entityName, MyEntity target)

Parameters

Type	Name	Description
System.String	entityName
MyEntity	target

DroneWaypointAdd(String, MyEntity)

Declaration

[VisualScriptingMiscData("AI", "Adds specific waypoint to specific drone.", -10510688)]
[VisualScriptingMember(true, false)]
public static void DroneWaypointAdd(string entityName, MyEntity waypoint)

Parameters

Type	Name	Description
System.String	entityName
MyEntity	waypoint

DroneWaypointClear(String)

Declaration

[VisualScriptingMiscData("AI", "Deletes all waypoints of specific drone.", -10510688)]
[VisualScriptingMember(true, false)]
public static void DroneWaypointClear(string entityName)

Parameters

Type	Name	Description
System.String	entityName

DroneWaypointSetCycling(String, Boolean)

Declaration

[VisualScriptingMiscData("AI", "Enables/disables waypoint cycling for specific drone.", -10510688)]
[VisualScriptingMember(true, false)]
public static void DroneWaypointSetCycling(string entityName, bool cycleWaypoints = true)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	cycleWaypoints

EnableBlock(String)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Enables functional block.", -10510688)]
[VisualScriptingMember(true, false)]
public static void EnableBlock(string blockName)

Parameters

Type	Name	Description
System.String	blockName

EnableCustomRespawn(Boolean, Int64)

Declaration

[VisualScriptingMember(true, false)]
[VisualScriptingMiscData("Gameplay", "Enable custom respawn. Needed for PlayerRequestsRespawn to work properly.", -10510688)]
public static void EnableCustomRespawn(bool enable = true, long playerId = -1L)

Parameters

Type	Name	Description
System.Boolean	enable
System.Int64	playerId

EnableHighlight(Boolean, Int64)

Declaration

[VisualScriptingMiscData("Questlog", "Enables highlight of the questlog for the specified player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void EnableHighlight(bool enable = true, long playerId = -1L)

Parameters

Type	Name	Description
System.Boolean	enable
System.Int64	playerId

EnableHighlightLocal(Boolean, Int64)

Declaration

public static void EnableHighlightLocal(bool enable = true, long playerId = -1L)

Parameters

Type	Name	Description
System.Boolean	enable
System.Int64	playerId

EnableSaving(Boolean)

Declaration

[VisualScriptingMiscData("Gameplay", "Allows all players to save", -10510688)]
[VisualScriptingMember(true, false)]
public static void EnableSaving(bool enable)

Parameters

Type	Name	Description
System.Boolean	enable

EnableSavingLocal(Boolean)

Declaration

public static void EnableSavingLocal(bool enable)

Parameters

Type	Name	Description
System.Boolean	enable

EnableTerminal(Boolean)

Declaration

[VisualScriptingMiscData("Gameplay", "Enables terminal screen.", -10510688)]
[VisualScriptingMember(true, false)]
public static void EnableTerminal(bool flag)

Parameters

Type	Name	Description
System.Boolean	flag

EnableToolbarConfig(Boolean)

Declaration

[VisualScriptingMiscData("G-Screen", "Enables/disables toolbar config screen (G-screen).", -10510688)]
[VisualScriptingMember(true, false)]
public static void EnableToolbarConfig(bool flag)

Parameters

Type	Name	Description
System.Boolean	flag

EndCutscene(Int64)

Declaration

[VisualScriptingMiscData("Cutscenes", "Ends current cutscene. If 'playerId' is -1, apply for all players, otherwise only for specific player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void EndCutscene(long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	playerId

EndCutsceneLocal(Int64)

Declaration

public static void EndCutsceneLocal(long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	playerId

EntityExists(String)

Declaration

[VisualScriptingMiscData("Entity", "Returns true if specific entity is present in the world.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool EntityExists(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.Boolean

FindFreePlace(Vector3D, out Vector3D, Single, Int32, Int32, Single)

Declaration

[VisualScriptingMiscData("Entity", "Finds free place around the specified position.", -10510688)]
[VisualScriptingMember(true, false)]
public static bool FindFreePlace(Vector3D position, out Vector3D newPosition, float radius, int maxTestCount = 20, int testsPerDistance = 5, float stepSize = 1F)

Parameters

Type	Name	Description
Vector3D	position
Vector3D	newPosition
System.Single	radius
System.Int32	maxTestCount
System.Int32	testsPerDistance
System.Single	stepSize

Returns

Type	Description
System.Boolean

FinishMission(String, Int32)

Declaration

[VisualScriptingMiscData("Gameplay", "Finishes active mission (state Mission Complete) with fadeout (ms).", -10510688)]
[VisualScriptingMember(true, false)]
public static void FinishMission(string outcome = "Mission Complete", int fadeTimeMs = 5000)

Parameters

Type	Name	Description
System.String	outcome
System.Int32	fadeTimeMs

FogSetAll(Nullable<Single>, Nullable<Single>, Nullable<Vector3>, Nullable<Single>, Nullable<Single>)

Declaration

[VisualScriptingMiscData("Environment", "Sets density, multiplier, color, skybox multiplier, and atmosphere multiplier of fog.", -10510688)]
[VisualScriptingMember(true, false)]
public static void FogSetAll(Nullable<float> density, Nullable<float> multiplier, Nullable<Vector3> color, Nullable<float> skyboxMultiplier, Nullable<float> atmoMultiplier)

Parameters

Type	Name	Description
System.Nullable<System.Single>	density
System.Nullable<System.Single>	multiplier
System.Nullable<Vector3>	color
System.Nullable<System.Single>	skyboxMultiplier
System.Nullable<System.Single>	atmoMultiplier

FogSetAtmoMultiplier(Single)

Declaration

[VisualScriptingMiscData("Environment", "Sets atmosphere multiplier of fog.", -10510688)]
[VisualScriptingMember(true, false)]
public static void FogSetAtmoMultiplier(float atmoMultiplier)

Parameters

Type	Name	Description
System.Single	atmoMultiplier

FogSetColor(Vector3)

Declaration

[VisualScriptingMiscData("Environment", "Sets color of fog.", -10510688)]
[VisualScriptingMember(true, false)]
public static void FogSetColor(Vector3 color)

Parameters

Type	Name	Description
Vector3	color

FogSetDensity(Single)

Declaration

[VisualScriptingMiscData("Environment", "Sets density of fog.", -10510688)]
[VisualScriptingMember(true, false)]
public static void FogSetDensity(float density)

Parameters

Type	Name	Description
System.Single	density

FogSetMultiplier(Single)

Declaration

[VisualScriptingMiscData("Environment", "Sets multiplier of fog.", -10510688)]
[VisualScriptingMember(true, false)]
public static void FogSetMultiplier(float multiplier)

Parameters

Type	Name	Description
System.Single	multiplier

FogSetSkyboxMultiplier(Single)

Declaration

[VisualScriptingMiscData("Environment", "Sets skybox multiplier of fog.", -10510688)]
[VisualScriptingMember(true, false)]
public static void FogSetSkyboxMultiplier(float skyboxMultiplier)

Parameters

Type	Name	Description
System.Single	skyboxMultiplier

GetAdmins()

Declaration

[VisualScriptingMiscData("Player", "Get admins.", -10510688)]
[VisualScriptingMember(false, false)]
public static List<long> GetAdmins()

Returns

Type	Description
System.Collections.Generic.List<System.Int64>

GetAllCockpits(String)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Get all cockpits in the grid", -10510688)]
[VisualScriptingMember(false, false)]
public static List<string> GetAllCockpits(string gridName)

Parameters

Type	Name	Description
System.String	gridName

Returns

Type	Description
System.Collections.Generic.List<System.String>

GetAllEntitiesInRay(Vector3D, Vector3D, out List<Single>)

Declaration

[VisualScriptingMiscData("Entity", "Returns List of ids of entities in hit by a line", -10510688)]
[VisualScriptingMember(false, false)]
public static List<long> GetAllEntitiesInRay(Vector3D from, Vector3D to, out List<float> distances)

Parameters

Type	Name	Description
Vector3D	from
Vector3D	to
System.Collections.Generic.List<System.Single>	distances

Returns

Type	Description
System.Collections.Generic.List<System.Int64>

GetBlockAttachedUpgradeModules(String, out Int32, out Int32, out Int32, out Int32, out Int32)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Returns ids of attached modules. Output parameters will contain additional informations.", -10510688)]
[VisualScriptingMember(false, false)]
public static List<long> GetBlockAttachedUpgradeModules(string blockName, out int modulesCount, out int workingCount, out int slotsUsed, out int slotsTotal, out int incompatibleCount)

Parameters

Type	Name	Description
System.String	blockName
System.Int32	modulesCount
System.Int32	workingCount
System.Int32	slotsUsed
System.Int32	slotsTotal
System.Int32	incompatibleCount

Returns

Type	Description
System.Collections.Generic.List<System.Int64>

GetBlockHealth(String, Boolean)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Returns current integrity of block in interval <0;1>.", -10510688)]
[VisualScriptingMember(false, false)]
public static float GetBlockHealth(string entityName, bool buildIntegrity = true)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	buildIntegrity

Returns

Type	Description
System.Single

GetColor(Single, Single, Single)

Declaration

[VisualScriptingMiscData("Misc", "Creates a new color out of red, green and blue. All values must be in range <0;1>.", -10510688)]
[VisualScriptingMember(false, false)]
public static Color GetColor(float r = 0F, float g = 0F, float b = 0F)

Parameters

Type	Name	Description
System.Single	r
System.Single	g
System.Single	b

Returns

Type	Description
Color

GetContentPath()

Declaration

[VisualScriptingMiscData("Misc", "Returns path to where game content is located.", -10510688)]
[VisualScriptingMember(false, false)]
public static string GetContentPath()

Returns

Type	Description
System.String

GetControlByName(MyGuiControlParent, String)

Declaration

[VisualScriptingMiscData("GUI", "Gets GUI element by name from the specific Gui element. You may search through hierarchy of controls by connecting element names with '\\'. Such as 'GrandParent\\Parent\\Child' will return element of name 'Child' that is under element 'Parent' that is under element 'GrandParent' which is in screen. In case specific element was not found, returned element will be the closest parent that was found.", -10510688)]
[VisualScriptingMember(false, false)]
public static MyGuiControlBase GetControlByName(this MyGuiControlParent control, string controlName)

Parameters

Type	Name	Description
Sandbox.Graphics.GUI.MyGuiControlParent	control
System.String	controlName

Returns

Type	Description
Sandbox.Graphics.GUI.MyGuiControlBase

GetControlByName(MyGuiScreenBase, String)

Declaration

[VisualScriptingMiscData("GUI", "Gets GUI element by name from the specific screen. You may search through hierarchy of controls by connecting element names with '\\\\'. Such as 'GrandParent\\\\Parent\\\\Child' will return element of name 'Child' that is under element 'Parent' that is under element 'GrandParent' which is in screen. In case specific element was not found, returned element will be the closest parent that was found.", -10510688)]
[VisualScriptingMember(false, false)]
public static MyGuiControlBase GetControlByName(this MyGuiScreenBase screen, string controlName)

Parameters

Type	Name	Description
Sandbox.Graphics.GUI.MyGuiScreenBase	screen
System.String	controlName

Returns

Type	Description
Sandbox.Graphics.GUI.MyGuiControlBase

GetCountOfSpecificGridBlocks(String, MyDefinitionId)

Declaration

[VisualScriptingMiscData("Grid", "Returns count of all blocks of type 'blockId' on specific grid.", -10510688)]
[VisualScriptingMember(false, false)]
public static int GetCountOfSpecificGridBlocks(string gridName, MyDefinitionId blockId)

Parameters

Type	Name	Description
System.String	gridName
MyDefinitionId	blockId

Returns

Type	Description
System.Int32

GetCurrentSessionPath()

Declaration

[VisualScriptingMiscData("Gameplay", "Gets path of the session (game/mission) currently being played.", -10510688)]
[VisualScriptingMember(false, false)]
public static string GetCurrentSessionPath()

Returns

Type	Description
System.String

GetDampenersEnabled(String)

Declaration

[VisualScriptingMiscData("Entity", "Returns true if entity has dampeners enabled, false otherwise.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool GetDampenersEnabled(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.Boolean

GetDataFromDefinition(MyDefinitionId, out String, out String)

Declaration

[VisualScriptingMiscData("Entity", "Gets typeId and subtypeId out of DefinitionId.", -10510688)]
[VisualScriptingMember(false, false)]
public static void GetDataFromDefinition(MyDefinitionId definitionId, out string typeId, out string subtypeId)

Parameters

Type	Name	Description
MyDefinitionId	definitionId
System.String	typeId
System.String	subtypeId

GetDefinitionId(String, String)

Declaration

[VisualScriptingMiscData("Entity", "Gets DefinitionId from typeId and subtypeId", -10510688)]
[VisualScriptingMember(false, false)]
public static MyDefinitionId GetDefinitionId(string typeId, string subtypeId)

Parameters

Type	Name	Description
System.String	typeId
System.String	subtypeId

Returns

Type	Description
MyDefinitionId

GetEntitiesInSphere(Vector3D, Single)

Declaration

[VisualScriptingMiscData("Entity", "Returns List of ids of entities in defined sphere", -10510688)]
[VisualScriptingMember(false, false)]
public static List<long> GetEntitiesInSphere(Vector3D position, float radius)

Parameters

Type	Name	Description
Vector3D	position
System.Single	radius

Returns

Type	Description
System.Collections.Generic.List<System.Int64>

GetEntityById(Int64)

Declaration

[VisualScriptingMiscData("Entity", "Gets specific entity by id.", -10510688)]
[VisualScriptingMember(false, false)]
public static MyEntity GetEntityById(long id)

Parameters

Type	Name	Description
System.Int64	id

Returns

Type	Description
MyEntity

GetEntityByName(String)

Declaration

[VisualScriptingMiscData("Entity", "Gets specific entity by name. If there are more entities by same name, the first one created will be taken.", -10510688)]
[VisualScriptingMember(false, false)]
public static MyEntity GetEntityByName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
MyEntity

GetEntityDirection(String, Base6Directions.Direction)

Declaration

[VisualScriptingMiscData("Entity", "Gets vector in world coordination system representing entity's direction (e.g. Direction.Forward will return real forward vector of entity in world coordination system.)", -10510688)]
[VisualScriptingMember(false, false)]
public static Vector3D GetEntityDirection(string entityName, Base6Directions.Direction direction)

Parameters

Type	Name	Description
System.String	entityName
Base6Directions.Direction	direction

Returns

Type	Description
Vector3D

GetEntityIdFromEntity(MyEntity)

Declaration

[VisualScriptingMiscData("Entity", "Gets entity id from specific entity.", -10510688)]
[VisualScriptingMember(false, false)]
public static long GetEntityIdFromEntity(MyEntity entity)

Parameters

Type	Name	Description
MyEntity	entity

Returns

Type	Description
System.Int64

GetEntityIdFromName(String)

Declaration

[VisualScriptingMiscData("Entity", "Returns entity id of specific entity ", -10510688)]
[VisualScriptingMember(false, false)]
public static long GetEntityIdFromName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Int64

GetEntityInventoryItemAmount(String, MyDefinitionId)

Declaration

[VisualScriptingMiscData("Entity", "Gets amount of specific items in inventory of entity. (rounded)", -10510688)]
[VisualScriptingMember(false, false)]
public static int GetEntityInventoryItemAmount(string entityName, MyDefinitionId itemId)

Parameters

Type	Name	Description
System.String	entityName
MyDefinitionId	itemId

Returns

Type	Description
System.Int32

GetEntityInventoryItemAmountPrecise(String, MyDefinitionId)

Declaration

[VisualScriptingMiscData("Entity", "Gets amount of specific items in inventory of entity.", -10510688)]
[VisualScriptingMember(false, false)]
public static float GetEntityInventoryItemAmountPrecise(string entityName, MyDefinitionId itemId)

Parameters

Type	Name	Description
System.String	entityName
MyDefinitionId	itemId

Returns

Type	Description
System.Single

GetEntityInventoryItemAtSlot(String, out MyDefinitionId, out Single, Int32, Int32)

Declaration

[VisualScriptingMiscData("Entity", "Returns true if entity has item in specific inventory on specific slot. Also return definition id of that item and its amount.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool GetEntityInventoryItemAtSlot(string entityName, out MyDefinitionId itemId, out float amount, int slot = 0, int inventoryId = 0)

Parameters

Type	Name	Description
System.String	entityName
MyDefinitionId	itemId
System.Single	amount
System.Int32	slot
System.Int32	inventoryId

Returns

Type	Description
System.Boolean

GetEntityName(Int64)

Declaration

[VisualScriptingMiscData("Entity", "Gets name of specific entity defined by id.", -10510688)]
[VisualScriptingMember(false, false)]
public static string GetEntityName(long entityId)

Parameters

Type	Name	Description
System.Int64	entityId

Returns

Type	Description
System.String

GetEntityPosition(String)

Declaration

[VisualScriptingMiscData("Entity", "Gets position of specific entity.", -10510688)]
[VisualScriptingMember(false, false)]
public static Vector3D GetEntityPosition(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
Vector3D

GetEntitySpeed(String)

Declaration

[VisualScriptingMiscData("Entity", "Gets linear velocity of specific entity.", -10510688)]
[VisualScriptingMember(false, false)]
public static Vector3D GetEntitySpeed(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
Vector3D

GetEntityVectors(String, out Vector3D, out Vector3D, out Vector3D)

Declaration

[VisualScriptingMiscData("Entity", "Breaks and returns world matrix of specific entity.", -10510688)]
[VisualScriptingMember(false, false)]
public static void GetEntityVectors(string entityName, out Vector3D position, out Vector3D forward, out Vector3D up)

Parameters

Type	Name	Description
System.String	entityName
Vector3D	position
Vector3D	forward
Vector3D	up

GetEntityWorldMatrix(MyEntity)

Declaration

[VisualScriptingMiscData("Entity", "Gets world matrix of specific entity.", -10510688)]
[VisualScriptingMember(false, false)]
public static MatrixD GetEntityWorldMatrix(MyEntity entity)

Parameters

Type	Name	Description
MyEntity	entity

Returns

Type	Description
MatrixD

GetFactionMembers(String)

Declaration

[VisualScriptingMiscData("Factions", "Returns list of all members (of theirs ids) of specific faction.", -10510688)]
[VisualScriptingMember(false, false)]
public static List<long> GetFactionMembers(string factionTag = "")

Parameters

Type	Name	Description
System.String	factionTag

Returns

Type	Description
System.Collections.Generic.List<System.Int64>

GetFriendlyName(MyGuiScreenBase)

Declaration

[VisualScriptingMiscData("GUI", "Gets friendly name of the specific screen.", -10510688)]
[VisualScriptingMember(false, false)]
public static string GetFriendlyName(this MyGuiScreenBase screen)

Parameters

Type	Name	Description
Sandbox.Graphics.GUI.MyGuiScreenBase	screen

Returns

Type	Description
System.String

GetGameplayElapsedTime(String)

Declaration

[VisualScriptingMiscData("Timers", "Return elapsed time in milliseconds for given timer.", -10510688)]
[VisualScriptingMember(false, false)]
public static int GetGameplayElapsedTime(string key)

Parameters

Type	Name	Description
System.String	key

Returns

Type	Description
System.Int32

GetGameplayElapsedTimeToString(String, String)

Declaration

[VisualScriptingMiscData("Timers", "Return elapsed time in milliseconds for given timer. Format according to https://docs.microsoft.com/cs-cz/dotnet/api/system.timespan.tostring", -10510688)]
[VisualScriptingMember(false, false)]
public static string GetGameplayElapsedTimeToString(string key, string format)

Parameters

Type	Name	Description
System.String	key
System.String	format

Returns

Type	Description
System.String

GetGameVolume()

Declaration

[VisualScriptingMiscData("Audio", "Get game volume.", -10510688)]
[VisualScriptingMember(false, false)]
public static float GetGameVolume()

Returns

Type	Description
System.Single

GetGridCockpitId(String, out Boolean, out Boolean, Boolean)

Declaration

[VisualScriptingMiscData("Grid", "Returns entity id of main cockpit or first cockpit found on grid. Also returns other info such as if cockpit is main or if any cockpit was found.", -10510688)]
[VisualScriptingMember(false, false)]
public static long GetGridCockpitId(string gridName, out bool isMainCockpit, out bool found, bool checkForEnabledShipControl = true)

Parameters

Type	Name	Description
System.String	gridName
System.Boolean	isMainCockpit
System.Boolean	found
System.Boolean	checkForEnabledShipControl

Returns

Type	Description
System.Int64

GetGridIdOfBlock(String)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Returns grid EntityId of grid that contains block with specific name. Returns 0 if name does not refer to a cube block. (If more entities have same name, only the first one created will be tested.)", -10510688)]
[VisualScriptingMember(false, false)]
public static long GetGridIdOfBlock(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.Int64

GetGridStatistics(String, out Single, out Single, out Int32)

Declaration

[VisualScriptingMiscData("Grid", "Returns sums of current integrities, max integrities, block counts.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool GetGridStatistics(string gridName, out float currentIntegrity, out float maxIntegrity, out int blockCount)

Parameters

Type	Name	Description
System.String	gridName
System.Single	currentIntegrity
System.Single	maxIntegrity
System.Int32	blockCount

Returns

Type	Description
System.Boolean

GetIdListOfSpecificGridBlocks(String, MyDefinitionId)

Declaration

[VisualScriptingMiscData("Grid", "Returns list of all blocks of type 'blockId' on specific grid.", -10510688)]
[VisualScriptingMember(false, false)]
public static List<long> GetIdListOfSpecificGridBlocks(string gridName, MyDefinitionId blockId)

Parameters

Type	Name	Description
System.String	gridName
MyDefinitionId	blockId

Returns

Type	Description
System.Collections.Generic.List<System.Int64>

GetIdOfFirstSpecificGridBlock(String, MyDefinitionId)

Declaration

[VisualScriptingMiscData("Grid", "Returns id of first block of type 'blockId' on specific grid.", -10510688)]
[VisualScriptingMember(false, false)]
public static long GetIdOfFirstSpecificGridBlock(string gridName, MyDefinitionId blockId)

Parameters

Type	Name	Description
System.String	gridName
MyDefinitionId	blockId

Returns

Type	Description
System.Int64

GetInteractedEntityInventoryItemIndexAndControl(MyDefinitionId, out MyGuiControlBase, out Int32)

Declaration

[VisualScriptingMiscData("GUI", "Gets whole inventory grid of interacted entity and find index of specific item in it. If no item was found, method will still return inventory grid and index will be set to last index in it (GetItemsCount() - 1). Works only when Terminal screen is opened and focused.", -10510688)]
[VisualScriptingMember(false, false)]
public static void GetInteractedEntityInventoryItemIndexAndControl(MyDefinitionId itemDefinition, out MyGuiControlBase control, out int index)

Parameters

Type	Name	Description
MyDefinitionId	itemDefinition
Sandbox.Graphics.GUI.MyGuiControlBase	control
System.Int32	index

GetLandingGearInformation(String, out Boolean, out Boolean, out String, out String)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Gets information about specific landing gear. Returns true if informations were obtained, false if no such Landing gear exists.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool GetLandingGearInformation(string entityName, out bool locked, out bool inConstraint, out string attachedType, out string attachedName)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	locked
System.Boolean	inConstraint
System.String	attachedType
System.String	attachedName

Returns

Type	Description
System.Boolean

GetLandingGearInformationFromEntity(MyEntity, out Boolean, out Boolean, out String, out String)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Gets information about specific landing gear. Returns true if informations were obtained, false if entity is not a Landing gear.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool GetLandingGearInformationFromEntity(MyEntity entity, out bool locked, out bool inConstraint, out string attachedType, out string attachedName)

Parameters

Type	Name	Description
MyEntity	entity
System.Boolean	locked
System.Boolean	inConstraint
System.String	attachedType
System.String	attachedName

Returns

Type	Description
System.Boolean

GetLocalPlayerId()

Declaration

[VisualScriptingMiscData("Factions", "Gets id of local player. Works only on Lobby and clients. On Dedicated server returns 0.", -10510688)]
[VisualScriptingMember(false, false)]
public static long GetLocalPlayerId()

Returns

Type	Description
System.Int64

GetMatchIsRunningState()

Declaration

[VisualScriptingMiscData("Other", "Get information whether component handling the match is running or not. Running component will have the time advancing and states will be changing.", -10510688)]
[VisualScriptingMember(true, false)]
public static bool GetMatchIsRunningState()

Returns

Type	Description
System.Boolean

GetMatchState()

Declaration

[VisualScriptingMiscData("Other", "Get name of the current state of the match.", -10510688)]
[VisualScriptingMember(true, false)]
public static string GetMatchState()

Returns

Type	Description
System.String

GetMatchStateRemainingDuration()

Declaration

[VisualScriptingMiscData("Other", "Get remaining time of the current match state. Time is in minutes.", -10510688)]
[VisualScriptingMember(true, false)]
public static float GetMatchStateRemainingDuration()

Returns

Type	Description
System.Single

GetMergeBlockStatus(String)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Returns merge block status ( -1 - block don't exist, 2 - Locked, 1 - Constrained, 0 - Otherwise).", -10510688)]
[VisualScriptingMember(false, false)]
public static int GetMergeBlockStatus(string mergeBlockName)

Parameters

Type	Name	Description
System.String	mergeBlockName

Returns

Type	Description
System.Int32

GetModsPath()

Declaration

[VisualScriptingMiscData("Misc", "Returns path to where mods are being stored.", -10510688)]
[VisualScriptingMember(false, false)]
public static string GetModsPath()

Returns

Type	Description
System.String

GetMusicVolume()

Declaration

[VisualScriptingMiscData("Audio", "Get music volume.", -10510688)]
[VisualScriptingMember(false, false)]
public static float GetMusicVolume()

Returns

Type	Description
System.Single

GetNearestPlanet(Vector3D)

Declaration

[VisualScriptingMiscData("Entity", "Returns name of a planet if point is close to a plane (in its natural gravity). Else returns 'Void'. !!!BEWARE 'Void' is just for English as this string is localized. For checking if there really is a planet or not use 'IsPlanetNearby(...)' function as output here might be inconsistent between localizations.", -10510688)]
[VisualScriptingMember(false, false)]
public static string GetNearestPlanet(Vector3D position)

Parameters

Type	Name	Description
Vector3D	position

Returns

Type	Description
System.String

GetNumberOfGridBlocks(String, String, String)

Declaration

[VisualScriptingMiscData("Grid", "Gets number of blocks of specified type on the specific grid.", -10510688)]
[VisualScriptingMember(false, false)]
public static int GetNumberOfGridBlocks(string entityName, string blockTypeId, string blockSubtypeId)

Parameters

Type	Name	Description
System.String	entityName
System.String	blockTypeId
System.String	blockSubtypeId

Returns

Type	Description
System.Int32

GetOnlinePlayers()

Declaration

[VisualScriptingMiscData("Player", "Gets online players.", -10510688)]
[VisualScriptingMember(false, false)]
public static List<long> GetOnlinePlayers()

Returns

Type	Description
System.Collections.Generic.List<System.Int64>

GetOpenedTerminal()

Declaration

[VisualScriptingMiscData("GUI", "Gets currently opened terminal screen. (only if it is focused)", -10510688)]
[VisualScriptingMember(false, false)]
public static MyGuiScreenTerminal GetOpenedTerminal()

Returns

Type	Description
Sandbox.Game.Gui.MyGuiScreenTerminal

GetOpenedToolbarConfig()

Declaration

[VisualScriptingMiscData("GUI", "Gets currently opened ToolbarConfig screen (G-Screen). (only if it is focused)", -10510688)]
[VisualScriptingMember(false, false)]
public static MyGuiScreenToolbarConfigBase GetOpenedToolbarConfig()

Returns

Type	Description
Sandbox.Game.Gui.MyGuiScreenToolbarConfigBase

GetOwner(String)

Declaration

[VisualScriptingMiscData("Entity", "Get owner of specific entity. 0 for nobody.", -10510688)]
[VisualScriptingMember(true, false)]
public static long GetOwner(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.Int64

GetOxygenLevelAtPlayersPosition(Int64)

Declaration

[VisualScriptingMiscData("Player", "Gets oxygen level at player's position.", -10510688)]
[VisualScriptingMember(false, false)]
public static float GetOxygenLevelAtPlayersPosition(long playerId = 0L)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
System.Single

GetPirateId()

Declaration

[VisualScriptingMiscData("Factions", "Gets id of pirate faction.", -10510688)]
[VisualScriptingMember(false, false)]
public static long GetPirateId()

Returns

Type	Description
System.Int64

GetPlayerControlledBlockData(out String, out Int64, out String, out Int64, out String, out Boolean, Int64)

Declaration

[VisualScriptingMiscData("Player", "Gets player's controlled cube block (grid).", -10510688)]
[VisualScriptingMember(false, false)]
public static bool GetPlayerControlledBlockData(out string controlType, out long blockId, out string blockName, out long gridId, out string gridName, out bool isRespawnShip, long playerId = 0L)

Parameters

Type	Name	Description
System.String	controlType
System.Int64	blockId
System.String	blockName
System.Int64	gridId
System.String	gridName
System.Boolean	isRespawnShip
System.Int64	playerId

Returns

Type	Description
System.Boolean

GetPlayerRespawnPoints(Int64)

Declaration

[VisualScriptingMiscData("Player", "Gets the player's available respawn points", -10510688)]
[VisualScriptingMember(true, false)]
public static int GetPlayerRespawnPoints(long playerId)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
System.Int32

GetPlayers()

Declaration

[VisualScriptingMiscData("Player", "Gets online and local players.", -10510688)]
[VisualScriptingMember(false, false)]
public static List<long> GetPlayers()

Returns

Type	Description
System.Collections.Generic.List<System.Int64>

GetPlayersCount()

Declaration

[VisualScriptingMiscData("Player", "Gets online and local players count.", -10510688)]
[VisualScriptingMember(false, false)]
public static int GetPlayersCount()

Returns

Type	Description
System.Int32

GetPlayersEnergyLevel(Int64)

Declaration

[VisualScriptingMiscData("Player", "Gets energy level of player's suit.", -10510688)]
[VisualScriptingMember(false, false)]
public static float GetPlayersEnergyLevel(long playerId = 0L)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
System.Single

GetPlayersEntityId(Int64)

Declaration

[VisualScriptingMiscData("Player", "Gets players entity ID.", -10510688)]
[VisualScriptingMember(false, false)]
public static long GetPlayersEntityId(long playerId = 0L)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
System.Int64

GetPlayersEntityName(Int64)

Declaration

[VisualScriptingMiscData("Player", "Gets players entity name.", -10510688)]
[VisualScriptingMember(false, false)]
public static string GetPlayersEntityName(long playerId = 0L)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
System.String

GetPlayersFactionName(Int64)

Declaration

[VisualScriptingMiscData("Factions", "Gets name of faction, specific player is in.", -10510688)]
[VisualScriptingMember(false, false)]
public static string GetPlayersFactionName(long playerId = 0L)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
System.String

GetPlayersFactionTag(Int64)

Declaration

[VisualScriptingMiscData("Factions", "Gets tag of faction, specific player is in.", -10510688)]
[VisualScriptingMember(false, false)]
public static string GetPlayersFactionTag(long playerId = 0L)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
System.String

GetPlayersHealth(Int64)

Declaration

[VisualScriptingMiscData("Player", "Gets player's health.", -10510688)]
[VisualScriptingMember(false, false)]
public static float GetPlayersHealth(long playerId = 0L)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
System.Single

GetPlayersHelmetStatus(Int64)

Declaration

[VisualScriptingMiscData("Player", "Gets player's helmet status.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool GetPlayersHelmetStatus(long playerId = 0L)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
System.Boolean

GetPlayersHydrogenLevel(Int64)

Declaration

[VisualScriptingMiscData("Player", "Gets hydrogen level of player's suit.", -10510688)]
[VisualScriptingMember(false, false)]
public static float GetPlayersHydrogenLevel(long playerId = 0L)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
System.Single

GetPlayersInventoryItemAmount(Int64, MyDefinitionId)

Declaration

[VisualScriptingMiscData("Player", "Gets player's inventory item amount.", -10510688)]
[VisualScriptingMember(false, false)]
public static int GetPlayersInventoryItemAmount(long playerId = 0L, MyDefinitionId itemId = null)

Parameters

Type	Name	Description
System.Int64	playerId
MyDefinitionId	itemId

Returns

Type	Description
System.Int32

GetPlayersInventoryItemAmountPrecise(Int64, MyDefinitionId)

Declaration

[VisualScriptingMiscData("Player", "Gets player's inventory item amount (precise).", -10510688)]
[VisualScriptingMember(false, false)]
public static float GetPlayersInventoryItemAmountPrecise(long playerId = 0L, MyDefinitionId itemId = null)

Parameters

Type	Name	Description
System.Int64	playerId
MyDefinitionId	itemId

Returns

Type	Description
System.Single

GetPlayersInventoryItemIndexAndControl(MyDefinitionId, out MyGuiControlBase, out Int32)

Declaration

[VisualScriptingMiscData("GUI", "Gets whole inventory grid of player and find index of specific item in it. If no item was found, method will still return inventory grid and index will be set to last index in it (GetItemsCount() - 1). Works only when Terminal screen is opened and focused.", -10510688)]
[VisualScriptingMember(false, false)]
public static void GetPlayersInventoryItemIndexAndControl(MyDefinitionId itemDefinition, out MyGuiControlBase control, out int index)

Parameters

Type	Name	Description
MyDefinitionId	itemDefinition
Sandbox.Graphics.GUI.MyGuiControlBase	control
System.Int32	index

GetPlayersName(Int64)

Declaration

[VisualScriptingMiscData("Player", "Gets player's name.", -10510688)]
[VisualScriptingMember(false, false)]
public static string GetPlayersName(long playerId = 0L)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
System.String

GetPlayersOxygenLevel(Int64)

Declaration

[VisualScriptingMiscData("Player", "Gets oxygen level of player's suit.", -10510688)]
[VisualScriptingMember(false, false)]
public static float GetPlayersOxygenLevel(long playerId = 0L)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
System.Single

GetPlayersPosition(Int64)

Declaration

[VisualScriptingMiscData("Player", "Gets player's position.", -10510688)]
[VisualScriptingMember(false, false)]
public static Vector3D GetPlayersPosition(long playerId = 0L)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
Vector3D

GetPlayersSpeed(Int64)

Declaration

[VisualScriptingMiscData("Player", "Gets player's speed (linear velocity).", -10510688)]
[VisualScriptingMember(false, false)]
public static Vector3D GetPlayersSpeed(long playerId = 0L)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
Vector3D

GetQuestlogMaxPages()

Declaration

[VisualScriptingMiscData("Questlog", "Obsolete. Returns -1.", -10510688)]
[VisualScriptingMember(false, false)]
public static int GetQuestlogMaxPages()

Returns

Type	Description
System.Int32

GetQuestlogPage()

Declaration

[VisualScriptingMiscData("Questlog", "Obsolete. Returns -1.", -10510688)]
[VisualScriptingMember(false, false)]
public static int GetQuestlogPage()

Returns

Type	Description
System.Int32

GetQuestlogPageFromMessage(Int32)

Declaration

[VisualScriptingMiscData("Questlog", "Obsolete. Returns -1.", -10510688)]
[VisualScriptingMember(false, false)]
public static int GetQuestlogPageFromMessage(int id = 0)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
System.Int32

GetRelationBetweenFactions(String, String)

Declaration

[VisualScriptingMiscData("Factions", "Returns current reputation between two factions. Returns int.MinValue (-2147483648) if either of factions is not found.", -10510688)]
[VisualScriptingMember(false, false)]
public static int GetRelationBetweenFactions(string tagA, string tagB)

Parameters

Type	Name	Description
System.String	tagA
System.String	tagB

Returns

Type	Description
System.Int32

GetRelationBetweenPlayerAndFaction(Int64, String)

Declaration

[VisualScriptingMiscData("Factions", "Returns current reputation between player and faction. Returns int.MinValue (-2147483648) if player or faction is not found.", -10510688)]
[VisualScriptingMember(false, false)]
public static int GetRelationBetweenPlayerAndFaction(long playerId, string tagB)

Parameters

Type	Name	Description
System.Int64	playerId
System.String	tagB

Returns

Type	Description
System.Int32

GetSavesPath()

Declaration

[VisualScriptingMiscData("Misc", "Returns path to where game is being saved.", -10510688)]
[VisualScriptingMember(false, false)]
public static string GetSavesPath()

Returns

Type	Description
System.String

GetSimulationQuality()

Declaration

[VisualScriptingMiscData("Gameplay", "Returns simulation quality (0 normal, 1 low, 2 verylow) currect platform can handle", -10510688)]
[VisualScriptingMember(false, false)]
public static int GetSimulationQuality()

Returns

Type	Description
System.Int32

GetSteamId(Int64)

Declaration

[VisualScriptingMember(false, false)]
[VisualScriptingMiscData("Gameplay", "Get Steam ID from player ID.", -10510688)]
public static ulong GetSteamId(long playerId)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
System.UInt64

GetSunDirection()

Declaration

[VisualScriptingMiscData("Environment", "Gets current sun rotation.", -10510688)]
[VisualScriptingMember(false, false)]
public static Vector3 GetSunDirection()

Returns

Type	Description
Vector3

GetTab(MyGuiControlTabControl, Int32)

Declaration

[VisualScriptingMiscData("GUI", "Gets tab on specific index of specified TabControl element.", -10510688)]
[VisualScriptingMember(false, false)]
public static MyGuiControlTabPage GetTab(this MyGuiControlTabControl tabs, int key)

Parameters

Type	Name	Description
Sandbox.Graphics.GUI.MyGuiControlTabControl	tabs
System.Int32	key

Returns

Type	Description
Sandbox.Graphics.GUI.MyGuiControlTabPage

GetTabs(MyGuiScreenTerminal)

Declaration

[VisualScriptingMiscData("GUI", "Gets TabControl elements of specific terminal screen.", -10510688)]
[VisualScriptingMember(false, false)]
public static MyGuiControlTabControl GetTabs(this MyGuiScreenTerminal terminal)

Parameters

Type	Name	Description
Sandbox.Game.Gui.MyGuiScreenTerminal	terminal

Returns

Type	Description
Sandbox.Graphics.GUI.MyGuiControlTabControl

GetTemperatureInPoint(Vector3D)

Declaration

[VisualScriptingMiscData("Environment", "Get temperature based on position", -10510688)]
[VisualScriptingMember(true, false)]
public static float GetTemperatureInPoint(Vector3D position)

Parameters

Type	Name	Description
Vector3D	position

Returns

Type	Description
System.Single

GetTimers()

Declaration

public static SerializableDictionary<string, (int, bool)> GetTimers()

Returns

Type	Description
VRage.Serialization.SerializableDictionary<System.String, System.ValueTuple<System.Int32, System.Boolean>>

GetToolbarConfigGridItemIndexAndControl(MyDefinitionId, out MyGuiControlBase, out Int32)

Declaration

[VisualScriptingMiscData("GUI", "Gets whole item grid and find index of specific item in it. If no item was found, method will still return the item grid and index will be set to last index in it (GetItemsCount() - 1). Works only when ToolbarConfig screen is opened and focused.", -10510688)]
[VisualScriptingMember(false, false)]
public static void GetToolbarConfigGridItemIndexAndControl(MyDefinitionId itemDefinition, out MyGuiControlBase control, out int index)

Parameters

Type	Name	Description
MyDefinitionId	itemDefinition
Sandbox.Graphics.GUI.MyGuiControlBase	control
System.Int32	index

GetUserControlKey(String)

Declaration

[VisualScriptingMiscData("Misc", "Gets name of the control element (keyboard, mouse, gamepad buttons) that is binded to the specific action called 'keyName'. Names are defined in class MyControlsSpace, such as 'STRAFE_LEFT' or 'CUBE_ROTATE_ROLL_POSITIVE'.", -10510688)]
[VisualScriptingMember(false, false)]
public static string GetUserControlKey(string keyName)

Parameters

Type	Name	Description
System.String	keyName

Returns

Type	Description
System.String

GetVoiceChatVolume()

Declaration

[VisualScriptingMiscData("Audio", "Get voice chat volume.", -10510688)]
[VisualScriptingMember(false, false)]
public static float GetVoiceChatVolume()

Returns

Type	Description
System.Single

GetWeather(Vector3D)

Declaration

[VisualScriptingMiscData("Environment", "Get weather based on position", -10510688)]
[VisualScriptingMember(true, false)]
public static string GetWeather(Vector3D position)

Parameters

Type	Name	Description
Vector3D	position

Returns

Type	Description
System.String

GetWeatherIntensity(Vector3D)

Declaration

[VisualScriptingMiscData("Environment", "Get weather intensity based on position", -10510688)]
[VisualScriptingMember(true, false)]
public static float GetWeatherIntensity(Vector3D position)

Parameters

Type	Name	Description
Vector3D	position

Returns

Type	Description
System.Single

GoToPostMatchState()

Declaration

[VisualScriptingMiscData("Other", "Go to post-match state", -10510688)]
[VisualScriptingMember(true, false)]
public static void GoToPostMatchState()

HasOperationalCockpit(String)

Declaration

[VisualScriptingMiscData("Grid", "Returns true if the specific grid has at least one cockpit that enables ship control.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool HasOperationalCockpit(string gridName)

Parameters

Type	Name	Description
System.String	gridName

Returns

Type	Description
System.Boolean

HasOperationalGyro(String)

Declaration

[VisualScriptingMiscData("Grid", "Returns true if the specific grid has at least one gyro that is enabled, powered and not-overridden.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool HasOperationalGyro(string gridName)

Parameters

Type	Name	Description
System.String	gridName

Returns

Type	Description
System.Boolean

HasPower(String)

Declaration

[VisualScriptingMiscData("Grid", "Returns true if grid has enough power or is in 'adaptable-overload'. (grid is overloaded by adaptable block, that won't cause blackout, such as thrusters or batteries)", -10510688)]
[VisualScriptingMember(false, false)]
public static bool HasPower(string gridName)

Parameters

Type	Name	Description
System.String	gridName

Returns

Type	Description
System.Boolean

HasThrusterInAllDirections(String)

Declaration

[VisualScriptingMiscData("Grid", "Returns true if entity has thrusters in all directions.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool HasThrusterInAllDirections(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.Boolean

HasWorkingRemote(String)

Declaration

[VisualScriptingMiscData("Grid", "Returns true if the specified grid has at least one Remote in functional state.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool HasWorkingRemote(string gridName)

Parameters

Type	Name	Description
System.String	gridName

Returns

Type	Description
System.Boolean

HighlightGuiControl(MyGuiControlBase, List<Int32>, String)

Declaration

[VisualScriptingMiscData("GUI", "Highlights specific GUI element. If the element is of type MyGuiControlGrid, 'indicies' may be used to select which items should be highlighted. 'customToolTipMessage' can be used for custom tooltip of highlighted element.", -10510688)]
[VisualScriptingMember(true, false)]
public static void HighlightGuiControl(MyGuiControlBase control, List<int> indicies = null, string customToolTipMessage = null)

Parameters

Type	Name	Description
Sandbox.Graphics.GUI.MyGuiControlBase	control
System.Collections.Generic.List<System.Int32>	indicies
System.String	customToolTipMessage

HighlightGuiControl(String, String)

Declaration

[VisualScriptingMiscData("GUI", "Highlights specific GUI element in specific screen.", -10510688)]
[VisualScriptingMember(true, false)]
public static void HighlightGuiControl(string controlName, string activeScreenName)

Parameters

Type	Name	Description
System.String	controlName
System.String	activeScreenName

Init()

Declaration

public static void Init()

InsertOffer(String, MyStoreItemData, out Int64)

Declaration

[VisualScriptingMiscData("Store", "Inserts offer to specified store.", -10510688)]
[VisualScriptingMember(true, false)]
public static MyStoreInsertResults InsertOffer(string storeEntityName, MyStoreItemData item, out long id)

Parameters

Type	Name	Description
System.String	storeEntityName
MyStoreItemData	item
System.Int64	id

Returns

Type	Description
MyStoreInsertResults

InsertOrder(String, MyStoreItemData, out Int64)

Declaration

[VisualScriptingMiscData("Store", "Inserts order to specified store.", -10510688)]
[VisualScriptingMember(true, false)]
public static MyStoreInsertResults InsertOrder(string storeEntityName, MyStoreItemData item, out long id)

Parameters

Type	Name	Description
System.String	storeEntityName
MyStoreItemData	item
System.Int64	id

Returns

Type	Description
MyStoreInsertResults

IsBlockEnabled(String)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Returns true if functional block exists and is enabled, otherwise false.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsBlockEnabled(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Boolean

IsBlockFunctional(String)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Returns true if specific cube block exists and is in functional state, otherwise false.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsBlockFunctional(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Boolean

IsBlockFunctionalById(Int64)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Returns true if specific cube block exists and is in functional state, otherwise false. Access block by Id", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsBlockFunctionalById(long id)

Parameters

Type	Name	Description
System.Int64	id

Returns

Type	Description
System.Boolean

IsBlockPositionAirtight(String)

Declaration

[VisualScriptingMiscData("Blocks Specific", "True if block is part of airtight room (Best used for AirVents).", -10510688)]
[VisualScriptingMember(true, false)]
public static bool IsBlockPositionAirtight(string blockName)

Parameters

Type	Name	Description
System.String	blockName

Returns

Type	Description
System.Boolean

IsBlockPowered(String)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Returns true if specific functional block exist and is powered, otherwise false. This does not relate to Enabled status, it indicates that there is power available for the block. ", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsBlockPowered(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Boolean

IsBlockWorking(String)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Returns true if specific functional block exists and is working, otherwise false.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsBlockWorking(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Boolean

IsConnectorLocked(String)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Returns true if specific connector is locked. False if unlocked of no such connector exists.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsConnectorLocked(string connectorName)

Parameters

Type	Name	Description
System.String	connectorName

Returns

Type	Description
System.Boolean

IsConveyorConnected(String, String)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Return true if 'secondBlock' is reachable from 'firstBlock'. (Can be only onle-way) ", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsConveyorConnected(string firstBlock, string secondBlock)

Parameters

Type	Name	Description
System.String	firstBlock
System.String	secondBlock

Returns

Type	Description
System.Boolean

IsCreative()

Declaration

[VisualScriptingMiscData("Gameplay", "Returns true if world is creative.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsCreative()

Returns

Type	Description
System.Boolean

IsDoorOpen(String)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Returns true if specific doors are open false if closed or door does not exist.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsDoorOpen(string doorBlockName)

Parameters

Type	Name	Description
System.String	doorBlockName

Returns

Type	Description
System.Boolean

IsFlyable(String)

Declaration

[VisualScriptingMiscData("Grid", "Returns true if the specified grid has at least one functional gyro, at least one controlling block (cockpit/remote) and thrusters in all directions.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsFlyable(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.Boolean

IsGameControlPressed(String)

Declaration

[VisualScriptingMiscData("Input", "Checks if input control is currently pressed.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsGameControlPressed(string controlStringId)

Parameters

Type	Name	Description
System.String	controlStringId

Returns

Type	Description
System.Boolean

IsGameControlReleased(String)

Declaration

[VisualScriptingMiscData("Input", "Checks if input control is currently released.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsGameControlReleased(string controlStringId)

Parameters

Type	Name	Description
System.String	controlStringId

Returns

Type	Description
System.Boolean

IsGameLoaded()

Declaration

[VisualScriptingMiscData("Gameplay", "Returns true if session is fully loaded.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsGameLoaded()

Returns

Type	Description
System.Boolean

IsGameSaving()

Declaration

[VisualScriptingMiscData("Gameplay", "Provides information if game is currently being saved", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsGameSaving()

Returns

Type	Description
System.Boolean

IsGridDestructible(String)

Declaration

[VisualScriptingMiscData("Grid", "Returns true if grid is marked as destructible.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsGridDestructible(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.Boolean

IsGridEditable(String)

Declaration

[VisualScriptingMiscData("Grid", "Returns true if the specific grid is marked as editable.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsGridEditable(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.Boolean

IsGridImmune(String)

Declaration

[VisualScriptingMiscData("Grid", "Returns true if grid is marked as destructible.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsGridImmune(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.Boolean

IsGridLockedWithLandingGear(String)

Declaration

[VisualScriptingMiscData("Grid", "Returns true if any Landing gear of specific grid is in locked state.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsGridLockedWithLandingGear(string gridName)

Parameters

Type	Name	Description
System.String	gridName

Returns

Type	Description
System.Boolean

IsLandingGearLocked(String)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Returns true if Landing gear is locked, false otherwise.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsLandingGearLocked(string entityName)

Parameters

Type	Name	Description
System.String	entityName

Returns

Type	Description
System.Boolean

IsNewGameControlPressed(String)

Declaration

[VisualScriptingMiscData("Input", "Checks if input control has been pressed this frame.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsNewGameControlPressed(string controlStringId)

Parameters

Type	Name	Description
System.String	controlStringId

Returns

Type	Description
System.Boolean

IsNewGameControlReleased(String)

Declaration

[VisualScriptingMiscData("Input", "Checks if input control has been released this frame.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsNewGameControlReleased(string controlStringId)

Parameters

Type	Name	Description
System.String	controlStringId

Returns

Type	Description
System.Boolean

IsNewKeyPressed(MyKeys)

Declaration

[VisualScriptingMiscData("GUI", "Returns true if specific key was pressed in this frame.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsNewKeyPressed(MyKeys key)

Parameters

Type	Name	Description
VRage.Input.MyKeys	key

Returns

Type	Description
System.Boolean

IsOnDarkSide(MyPlanet, Vector3D)

Declaration

[VisualScriptingMiscData("Environment", "Returns true if position is on dark side of a planet.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsOnDarkSide(MyPlanet planet, Vector3D position)

Parameters

Type	Name	Description
MyPlanet	planet
Vector3D	position

Returns

Type	Description
System.Boolean

IsPlanetNearby(Vector3D)

Declaration

[VisualScriptingMiscData("Entity", "Returns true if point is in natural gravity close to planet(eg. if nearest planet exists).", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsPlanetNearby(Vector3D position)

Parameters

Type	Name	Description
Vector3D	position

Returns

Type	Description
System.Boolean

IsPlayerDead(Int64)

Declaration

[VisualScriptingMiscData("Player", "Checks if player is dead.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsPlayerDead(long playerId = 0L)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
System.Boolean

IsPlayerInCockpit(Int64, String, String)

Declaration

[VisualScriptingMiscData("Player", "Checks if player is in cockpit.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsPlayerInCockpit(long playerId = 0L, string gridName = null, string cockpitName = null)

Parameters

Type	Name	Description
System.Int64	playerId
System.String	gridName
System.String	cockpitName

Returns

Type	Description
System.Boolean

IsPlayerInRemote(Int64, String, String)

Declaration

[VisualScriptingMiscData("Player", "Checks if player is controlling something over remote.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsPlayerInRemote(long playerId = 0L, string gridName = null, string remoteName = null)

Parameters

Type	Name	Description
System.Int64	playerId
System.String	gridName
System.String	remoteName

Returns

Type	Description
System.Boolean

IsPlayerInWeapon(Int64, String, String)

Declaration

[VisualScriptingMiscData("Player", "Checks if player is controlling weapon.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsPlayerInWeapon(long playerId = 0L, string gridName = null, string weaponName = null)

Parameters

Type	Name	Description
System.Int64	playerId
System.String	gridName
System.String	weaponName

Returns

Type	Description
System.Boolean

IsPlayersJetpackEnabled(Int64)

Declaration

[VisualScriptingMiscData("Player", "Checks if player's jetpack is enabled.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsPlayersJetpackEnabled(long playerId = 0L)

Parameters

Type	Name	Description
System.Int64	playerId

Returns

Type	Description
System.Boolean

IsSavingEnabled()

Declaration

[VisualScriptingMiscData("Gameplay", "Allows all players to save", -10510688)]
public static bool IsSavingEnabled()

Returns

Type	Description
System.Boolean

IsSurvival()

Declaration

[VisualScriptingMiscData("Gameplay", "Returns true if world is survival.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool IsSurvival()

Returns

Type	Description
System.Boolean

IsUnderGround(Vector3D)

Declaration

[VisualScriptingMiscData("Environment", "Returns true if position is underground", -10510688)]
[VisualScriptingMember(true, false)]
public static bool IsUnderGround(Vector3D position)

Parameters

Type	Name	Description
Vector3D	position

Returns

Type	Description
System.Boolean

JoinResult(JoinResult)

Declaration

[VisualScriptingMember(false, false)]
[VisualScriptingMiscData("Other", "Enum constants", -10510688)]
public static JoinResult JoinResult(JoinResult value)

Parameters

Type	Name	Description
VRage.Network.JoinResult	value

Returns

Type	Description
VRage.Network.JoinResult

KickPlayer(UInt64, Boolean, Boolean)

Declaration

[VisualScriptingMember(true, false)]
[VisualScriptingMiscData("Gameplay", "Kick player.", -10510688)]
public static void KickPlayer(ulong steamId, bool kick = true, bool add = true)

Parameters

Type	Name	Description
System.UInt64	steamId
System.Boolean	kick
System.Boolean	add

KickPlayerFromFaction(Int64)

Declaration

[VisualScriptingMiscData("Factions", "Kicks specific player from faction he is in.", -10510688)]
[VisualScriptingMember(true, false)]
public static void KickPlayerFromFaction(long playerId = 0L)

Parameters

Type	Name	Description
System.Int64	playerId

LoadEntityBool(String, String)

Declaration

[VisualScriptingMiscData("Entity Storage", "Loads boolean from the entity storage.", -10510688)]
[VisualScriptingMember(false, false)]
public static bool LoadEntityBool(string entityName, string key)

Parameters

Type	Name	Description
System.String	entityName
System.String	key

Returns

Type	Description
System.Boolean

LoadEntityBoolList(String, String)

Declaration

[VisualScriptingMiscData("Entity Storage", "Loads boolean list from the entity storage.", -10510688)]
[VisualScriptingMember(false, false)]
public static List<bool> LoadEntityBoolList(string entityName, string key)

Parameters

Type	Name	Description
System.String	entityName
System.String	key

Returns

Type	Description
System.Collections.Generic.List<System.Boolean>

LoadEntityFloat(String, String)

Declaration

[VisualScriptingMiscData("Entity Storage", "Loads float from the entity storage.", -10510688)]
[VisualScriptingMember(false, false)]
public static float LoadEntityFloat(string entityName, string key)

Parameters

Type	Name	Description
System.String	entityName
System.String	key

Returns

Type	Description
System.Single

LoadEntityFloatList(String, String)

Declaration

[VisualScriptingMiscData("Entity Storage", "Loads float from the entity storage.", -10510688)]
[VisualScriptingMember(false, false)]
public static List<float> LoadEntityFloatList(string entityName, string key)

Parameters

Type	Name	Description
System.String	entityName
System.String	key

Returns

Type	Description
System.Collections.Generic.List<System.Single>

LoadEntityInteger(String, String)

Declaration

[VisualScriptingMiscData("Entity Storage", "Loads integer from the entity storage.", -10510688)]
[VisualScriptingMember(false, false)]
public static int LoadEntityInteger(string entityName, string key)

Parameters

Type	Name	Description
System.String	entityName
System.String	key

Returns

Type	Description
System.Int32

LoadEntityIntegerList(String, String)

Declaration

[VisualScriptingMiscData("Entity Storage", "Loads integer list from the entity storage.", -10510688)]
[VisualScriptingMember(false, false)]
public static List<int> LoadEntityIntegerList(string entityName, string key)

Parameters

Type	Name	Description
System.String	entityName
System.String	key

Returns

Type	Description
System.Collections.Generic.List<System.Int32>

LoadEntityLong(String, String)

Declaration

[VisualScriptingMiscData("Entity Storage", "Loads long integer from the entity storage.", -10510688)]
[VisualScriptingMember(false, false)]
public static long LoadEntityLong(string entityName, string key)

Parameters

Type	Name	Description
System.String	entityName
System.String	key

Returns

Type	Description
System.Int64

LoadEntityLongList(String, String)

Declaration

[VisualScriptingMiscData("Entity Storage", "Loads long list from the entity storage.", -10510688)]
[VisualScriptingMember(false, false)]
public static List<long> LoadEntityLongList(string entityName, string key)

Parameters

Type	Name	Description
System.String	entityName
System.String	key

Returns

Type	Description
System.Collections.Generic.List<System.Int64>

LoadEntityString(String, String)

Declaration

[VisualScriptingMiscData("Entity Storage", "Loads string from the entity storage.", -10510688)]
[VisualScriptingMember(false, false)]
public static string LoadEntityString(string entityName, string key)

Parameters

Type	Name	Description
System.String	entityName
System.String	key

Returns

Type	Description
System.String

LoadEntityStringList(String, String)

Declaration

[VisualScriptingMiscData("Entity Storage", "Loads string list from the entity storage.", -10510688)]
[VisualScriptingMember(false, false)]
public static List<string> LoadEntityStringList(string entityName, string key)

Parameters

Type	Name	Description
System.String	entityName
System.String	key

Returns

Type	Description
System.Collections.Generic.List<System.String>

LoadEntityVector(String, String)

Declaration

[VisualScriptingMiscData("Entity Storage", "Loads Vector3D (doubles) from the entity storage.", -10510688)]
[VisualScriptingMember(false, false)]
public static Vector3D LoadEntityVector(string entityName, string key)

Parameters

Type	Name	Description
System.String	entityName
System.String	key

Returns

Type	Description
Vector3D

LoadEntityVectorList(String, String)

Declaration

[VisualScriptingMiscData("Entity Storage", "Loads Vector3D (doubles) from the entity storage.", -10510688)]
[VisualScriptingMember(false, false)]
public static List<Vector3D> LoadEntityVectorList(string entityName, string key)

Parameters

Type	Name	Description
System.String	entityName
System.String	key

Returns

Type	Description
System.Collections.Generic.List<Vector3D>

MusicPlayMusicCategory(String, Boolean, Int64)

Declaration

[VisualScriptingMiscData("Audio", "Sets currently selected category to specific category and play a track from it.", -10510688)]
[VisualScriptingMember(true, false)]
public static void MusicPlayMusicCategory(string categoryName, bool playAtLeastOnce = true, long playerId = -1L)

Parameters

Type	Name	Description
System.String	categoryName
System.Boolean	playAtLeastOnce
System.Int64	playerId

MusicPlayMusicCategoryLocal(String, Boolean)

Declaration

public static void MusicPlayMusicCategoryLocal(string categoryName, bool playAtLeastOnce = true)

Parameters

Type	Name	Description
System.String	categoryName
System.Boolean	playAtLeastOnce

MusicPlayMusicCue(String, Boolean)

Declaration

[VisualScriptingMiscData("Audio", "Plays specific music cue.", -10510688)]
[VisualScriptingMember(true, false)]
public static void MusicPlayMusicCue(string cueName, bool playAtLeastOnce = true)

Parameters

Type	Name	Description
System.String	cueName
System.Boolean	playAtLeastOnce

MusicPlayMusicCueLocal(String, Boolean)

Declaration

public static void MusicPlayMusicCueLocal(string cueName, bool playAtLeastOnce = true)

Parameters

Type	Name	Description
System.String	cueName
System.Boolean	playAtLeastOnce

MusicSetDynamicMusic(Boolean)

Declaration

[VisualScriptingMiscData("Audio", "Enables/disables dynamic music category changes.", -10510688)]
[VisualScriptingMember(true, false)]
public static void MusicSetDynamicMusic(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled

MusicSetDynamicMusicLocal(Boolean)

Declaration

public static void MusicSetDynamicMusicLocal(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled

MusicSetMusicCategory(String)

Declaration

[VisualScriptingMiscData("Audio", "Sets currently selected category to specific music category.", -10510688)]
[VisualScriptingMember(true, false)]
public static void MusicSetMusicCategory(string categoryName)

Parameters

Type	Name	Description
System.String	categoryName

MusicSetMusicCategoryLocal(String)

Declaration

public static void MusicSetMusicCategoryLocal(string categoryName)

Parameters

Type	Name	Description
System.String	categoryName

NextCutsceneNode(Int64)

Declaration

[VisualScriptingMiscData("Cutscenes", "Goes to next node in current cutscene. If 'playerId' is -1, apply for all players, otherwise only for specific player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void NextCutsceneNode(long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	playerId

NextCutsceneNodeLocal(Int64)

Declaration

public static void NextCutsceneNodeLocal(long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	playerId

OpenFactionVictoryScreenAll(String, Single)

Declaration

[VisualScriptingMiscData("GUI", "Open Player screen to all players.", -10510688)]
[VisualScriptingMember(true, false)]
public static void OpenFactionVictoryScreenAll(string factionTag, float timeInSec)

Parameters

Type	Name	Description
System.String	factionTag
System.Single	timeInSec

OpenFactionVictoryScreenAllBroadcast(String, Single)

Declaration

[Event(null, 6095)]
[Reliable]
[ServerInvoked]
[Broadcast]
public static void OpenFactionVictoryScreenAllBroadcast(string factionTag, float timeInSec)

Parameters

Type	Name	Description
System.String	factionTag
System.Single	timeInSec

OpenPlayerScreenAll()

Declaration

[VisualScriptingMiscData("GUI", "Open Player screen to all players.", -10510688)]
[VisualScriptingMember(true, false)]
public static void OpenPlayerScreenAll()

OpenPlayerScreenAllBroadcast()

Declaration

[Event(null, 6073)]
[Reliable]
[ServerInvoked]
[Broadcast]
public static void OpenPlayerScreenAllBroadcast()

OpenSteamOverlay(String, Int64)

Declaration

[VisualScriptingMiscData("GUI", "Opens service overlay. If playerID is 0, open it for local player else open it for targeted player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void OpenSteamOverlay(string url, long playerId = 0L)

Parameters

Type	Name	Description
System.String	url
System.Int64	playerId

OpenSteamOverlayLocal(String)

Declaration

public static void OpenSteamOverlayLocal(string url)

Parameters

Type	Name	Description
System.String	url

PlayerResearchClear(Int64)

Declaration

[VisualScriptingMiscData("G-Screen", "Resets research for the specific player. If 'playerId' equals -1, resets research for the local player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void PlayerResearchClear(long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	playerId

PlayerResearchClearAll()

Declaration

[VisualScriptingMiscData("G-Screen", "Resets research for all.", -10510688)]
[VisualScriptingMember(true, false)]
public static void PlayerResearchClearAll()

PlayerResearchLock(Int64, MyDefinitionId)

Declaration

[VisualScriptingMiscData("G-Screen", "Locks the specific research for the specific player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void PlayerResearchLock(long playerId, MyDefinitionId itemId)

Parameters

Type	Name	Description
System.Int64	playerId
MyDefinitionId	itemId

PlayerResearchUnlock(Int64, MyDefinitionId)

Declaration

[VisualScriptingMiscData("G-Screen", "Unlocks the specific research for the specific player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void PlayerResearchUnlock(long playerId, MyDefinitionId itemId)

Parameters

Type	Name	Description
System.Int64	playerId
MyDefinitionId	itemId

PlayHudSound(MyGuiSounds, Int64)

Declaration

[VisualScriptingMiscData("Audio", "Plays specific 2D HUD sound.", -10510688)]
[VisualScriptingMember(true, false)]
public static void PlayHudSound(MyGuiSounds sound, long playerId = 0L)

Parameters

Type	Name	Description
VRage.Audio.MyGuiSounds	sound
System.Int64	playerId

PlayHudSoundLocal(MyGuiSounds, Int64)

Declaration

public static void PlayHudSoundLocal(MyGuiSounds sound, long playerId = 0L)

Parameters

Type	Name	Description
VRage.Audio.MyGuiSounds	sound
System.Int64	playerId

PlaySingleSoundAtEntity(String, String)

Declaration

[VisualScriptingMiscData("Audio", "Plays single sound on emitter attached to specific entity.", -10510688)]
[VisualScriptingMember(true, false)]
public static void PlaySingleSoundAtEntity(string soundName, string entityName)

Parameters

Type	Name	Description
System.String	soundName
System.String	entityName

PlaySingleSoundAtEntityLocal(String, String)

Declaration

public static void PlaySingleSoundAtEntityLocal(string soundName, string entityName)

Parameters

Type	Name	Description
System.String	soundName
System.String	entityName

PlaySingleSoundAtPosition(String, Vector3D)

Declaration

[VisualScriptingMiscData("Audio", "Plays specific 3D sound at specific point.", -10510688)]
[VisualScriptingMember(true, false)]
public static void PlaySingleSoundAtPosition([Nullable] string soundName, Vector3D position)

Parameters

Type	Name	Description
System.String	soundName
Vector3D	position

PlaySingleSoundAtPositionLocal(String, Vector3D)

Declaration

public static void PlaySingleSoundAtPositionLocal(string soundName, Vector3D position)

Parameters

Type	Name	Description
System.String	soundName
Vector3D	position

PlaySound(String, String, Boolean)

Declaration

[VisualScriptingMiscData("Audio", "Plays sound on specific emitter. If 'playIn2D' is true, sound will be forced 2D.", -10510688)]
[VisualScriptingMember(true, false)]
public static void PlaySound([Nullable] string emitterId, string soundName, bool playIn2D = false)

Parameters

Type	Name	Description
System.String	emitterId
System.String	soundName
System.Boolean	playIn2D

PlaySoundAmbient(String)

Declaration

[VisualScriptingMiscData("Audio", "Play ambient 2D sound.", -10510688)]
[VisualScriptingMember(true, false)]
public static void PlaySoundAmbient(string soundName)

Parameters

Type	Name	Description
System.String	soundName

PlaySoundAmbientLocal(String)

Declaration

public static void PlaySoundAmbientLocal(string soundName)

Parameters

Type	Name	Description
System.String	soundName

PlaySoundLocal(String, String, Boolean)

Declaration

public static void PlaySoundLocal([Nullable] string emitterId, string soundName, bool playIn2D = false)

Parameters

Type	Name	Description
System.String	emitterId
System.String	soundName
System.Boolean	playIn2D

ReloadToolbarDefaults(Int64)

Declaration

[VisualScriptingMiscData("Toolbar", "Reloads default settings for the toolbar", -10510688)]
[VisualScriptingMember(true, false)]
public static void ReloadToolbarDefaults(long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	playerId

ReloadToolbarDefaultsLocal(Int64)

Declaration

public static void ReloadToolbarDefaultsLocal(long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	playerId

RemoveAllTriggersFromEntity(String)

Declaration

[VisualScriptingMiscData("Triggers", "Removes all area triggers from the specified entity.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveAllTriggersFromEntity(string entityName)

Parameters

Type	Name	Description
System.String	entityName

RemoveBoardScreen(String, Int64)

Declaration

[VisualScriptingMiscData("Board screen", "Remove board screen with specific id. PlayerId -1 stands for all players, 0 for local player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveBoardScreen(string boardId, long playerId = -1L)

Parameters

Type	Name	Description
System.String	boardId
System.Int64	playerId

RemoveColumn(String, String, Int64)

Declaration

[VisualScriptingMiscData("Board screen", "Remove column from board screen.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveColumn(string boardId, string columnId, long playerId = -1L)

Parameters

Type	Name	Description
System.String	boardId
System.String	columnId
System.Int64	playerId

RemoveContract(Int64)

Declaration

[VisualScriptingMiscData("Contract", "Remove inactive contract. Does not work if contract has already been accepted.", -10510688)]
[VisualScriptingMember(true, false)]
public static bool RemoveContract(long id)

Parameters

Type	Name	Description
System.Int64	id

Returns

Type	Description
System.Boolean

RemoveEntities(Vector3D, Double, Boolean, Boolean, String)

Declaration

[VisualScriptingMiscData("Entity", "Removes entities in designated area.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveEntities(Vector3D position, double radius, bool removePlanets = true, bool removeGroup = true, string typeRestriction = null)

Parameters

Type	Name	Description
Vector3D	position
System.Double	radius
System.Boolean	removePlanets
System.Boolean	removeGroup
System.String	typeRestriction

RemoveEntity(Int64, Boolean, String)

Declaration

[VisualScriptingMiscData("Entity", "Removes specific entity from world.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveEntity(long entityId, bool removeGroup = true, string typeRestriction = null)

Parameters

Type	Name	Description
System.Int64	entityId
System.Boolean	removeGroup
System.String	typeRestriction

RemoveEntity(String, Boolean, String)

Declaration

[VisualScriptingMiscData("Entity", "Removes specific entity from world.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveEntity(string entityName, bool removeGroup = true, string typeRestriction = null)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	removeGroup
System.String	typeRestriction

RemoveEntity(MyEntity, Boolean, String)

Declaration

[VisualScriptingMiscData("Entity", "Removes specific entity from world.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveEntity(MyEntity entity, bool removeGroup = true, string typeRestriction = null)

Parameters

Type	Name	Description
MyEntity	entity
System.Boolean	removeGroup
System.String	typeRestriction

RemoveFromEntityInventory(String, MyDefinitionId, Single)

Declaration

[VisualScriptingMiscData("Entity", "Removes item defined by id in specific quantity from inventory of entity.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveFromEntityInventory(string entityName, MyDefinitionId itemId = null, float amount = 1F)

Parameters

Type	Name	Description
System.String	entityName
MyDefinitionId	itemId
System.Single	amount

RemoveFromPlayersInventory(Int64, MyDefinitionId, Int32)

Declaration

[VisualScriptingMiscData("Player", "Removes the specified item from the player's inventory.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveFromPlayersInventory(long playerId = 0L, MyDefinitionId itemId = null, int amount = 1)

Parameters

Type	Name	Description
System.Int64	playerId
MyDefinitionId	itemId
System.Int32	amount

RemoveGPS(String, Int64)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Removes GPS from specific player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveGPS(string name, long playerId = -1L)

Parameters

Type	Name	Description
System.String	name
System.Int64	playerId

RemoveGPSForAll(String)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Removes GPS from all players.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveGPSForAll(string name)

Parameters

Type	Name	Description
System.String	name

RemoveGPSFromEntity(String, String, String, Int64)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Removes specific GPS from specific entity for local player only. ('GPSDescription' is not used. Cant remove due to backward compatibility.)", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveGPSFromEntity(string entityName, string GPSName, string GPSDescription, long playerId = -1L)

Parameters

Type	Name	Description
System.String	entityName
System.String	GPSName
System.String	GPSDescription
System.Int64	playerId

RemoveGPSFromEntityForAll(String, String, String)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Removes specific GPS from specific entity for all players. ('GPSDescription' is not used. Cant remove due to backward compatibility.)", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveGPSFromEntityForAll(string entityName, string GPSName, string GPSDescription)

Parameters

Type	Name	Description
System.String	entityName
System.String	GPSName
System.String	GPSDescription

RemoveGridFromTargetList(String, String)

Declaration

[VisualScriptingMiscData("AI", "Removes specific grid from drone's targets.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveGridFromTargetList(string gridName, string targetGridname)

Parameters

Type	Name	Description
System.String	gridName
System.String	targetGridname

RemoveNotification(Int32, Int64)

Declaration

[VisualScriptingMiscData("Notifications", "Removes the specific notification referenced by its id from the specific player. If 'playerId' is equal to 0, apply on local player, if -1, apply to all.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveNotification(int messageId, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	messageId
System.Int64	playerId

RemoveNotificationLocal(Int32, Int64)

Declaration

public static void RemoveNotificationLocal(int messageId, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	messageId
System.Int64	playerId

RemoveQuestlogDetails(Int64)

Declaration

[VisualScriptingMiscData("Questlog", "Removes details of the quest for the specified player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveQuestlogDetails(long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	playerId

RemoveQuestlogDetailsLocal(Int64)

Declaration

public static void RemoveQuestlogDetailsLocal(long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	playerId

RemoveRow(String, String, Int64)

Declaration

[VisualScriptingMiscData("Board screen", "Add row to board screen.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveRow(string boardId, string rowId, long playerId = -1L)

Parameters

Type	Name	Description
System.String	boardId
System.String	rowId
System.Int64	playerId

RemoveSoundEmitter(String)

Declaration

[VisualScriptingMiscData("Audio", "Removes specific sound emitter.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveSoundEmitter([Nullable] string emitterId)

Parameters

Type	Name	Description
System.String	emitterId

RemoveSoundEmitterLocal(String)

Declaration

public static void RemoveSoundEmitterLocal(string emitterId)

Parameters

Type	Name	Description
System.String	emitterId

RemoveTrigger(String)

Declaration

[VisualScriptingMiscData("Triggers", "Remove area trigger with the specified name.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveTrigger(string triggerName)

Parameters

Type	Name	Description
System.String	triggerName

RemoveUIString(Int64, Int64)

Declaration

[VisualScriptingMiscData("UIString", "Remove UI string with specific id. PlayerId -1 stands for all players, 0 for local player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveUIString(long id, long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	id
System.Int64	playerId

RemoveWeather(Vector3D)

Declaration

[VisualScriptingMiscData("Environment", "Remove a weather based on position", -10510688)]
[VisualScriptingMember(true, false)]
public static void RemoveWeather(Vector3D position)

Parameters

Type	Name	Description
Vector3D	position

RenameEntity(String, String)

Declaration

[VisualScriptingMiscData("Entity", "Renames specific entity.", -10510688)]
[VisualScriptingMember(true, false)]
public static void RenameEntity(string oldName, string newName = null)

Parameters

Type	Name	Description
System.String	oldName
System.String	newName

ReplaceQuestlogDetail(Int32, String, Boolean, Int64)

Declaration

[VisualScriptingMiscData("Questlog", "Replaces detail of the quest for the specified player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ReplaceQuestlogDetail(int id = 0, string newDetail = "", bool useTyping = true, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	id
System.String	newDetail
System.Boolean	useTyping
System.Int64	playerId

ReplaceQuestlogDetailLocal(Int32, String, Boolean, Int64)

Declaration

public static void ReplaceQuestlogDetailLocal(int id = 0, string newDetail = "", bool useTyping = true, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	id
System.String	newDetail
System.Boolean	useTyping
System.Int64	playerId

ReportMatchEndToAnalytics(String, Int32)

Declaration

[VisualScriptingMiscData("Other", "Report match result and time to analytics", -10510688)]
[VisualScriptingMember(true, false)]
public static void ReportMatchEndToAnalytics(string result, int matchTime)

Parameters

Type	Name	Description
System.String	result
System.Int32	matchTime

RequestVicinityCache(Int64)

Declaration

[VisualScriptingMiscData("Cutscenes", "Preload entity on clients to prevent streaming and popping", -10510688)]
[VisualScriptingMember(true, false)]
public static void RequestVicinityCache(long entityId)

Parameters

Type	Name	Description
System.Int64	entityId

RequestVicinityCacheLocal(Int64)

Declaration

public static void RequestVicinityCacheLocal(long entityId = -1L)

Parameters

Type	Name	Description
System.Int64	entityId

ResearchListAddItem(MyDefinitionId)

Declaration

[VisualScriptingMiscData("G-Screen", "Adds specific item into research.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ResearchListAddItem(MyDefinitionId itemId)

Parameters

Type	Name	Description
MyDefinitionId	itemId

ResearchListClear()

Declaration

[VisualScriptingMiscData("G-Screen", "Clears required research list for all.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ResearchListClear()

ResearchListRemoveItem(MyDefinitionId)

Declaration

[VisualScriptingMiscData("G-Screen", "Removes specific item from research.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ResearchListRemoveItem(MyDefinitionId itemId)

Parameters

Type	Name	Description
MyDefinitionId	itemId

ResearchListWhitelist(Boolean)

Declaration

[VisualScriptingMiscData("G-Screen", "[OBSOLETE] Enables/disables research whitelist mode.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ResearchListWhitelist(bool whitelist)

Parameters

Type	Name	Description
System.Boolean	whitelist

SaveSession()

Declaration

[VisualScriptingMiscData("Gameplay", "Saves the game.", -10510688)]
[VisualScriptingMember(true, false)]
public static bool SaveSession()

Returns

Type	Description
System.Boolean

SaveSessionAs(String)

Declaration

[VisualScriptingMiscData("Gameplay", "Saves the game under specific name.", -10510688)]
[VisualScriptingMember(true, false)]
public static bool SaveSessionAs(string saveName)

Parameters

Type	Name	Description
System.String	saveName

Returns

Type	Description
System.Boolean

ScreenColorFadingMinimalizeHUD(Boolean, Int64)

Declaration

[VisualScriptingMiscData("Effects", "Sets if screen fade should minimize HUD.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ScreenColorFadingMinimalizeHUD(bool minimalize = true, long playerId = -1L)

Parameters

Type	Name	Description
System.Boolean	minimalize
System.Int64	playerId

ScreenColorFadingSetColor(Color, Int64)

Declaration

[VisualScriptingMiscData("Effects", "Sets target color for screen fading.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ScreenColorFadingSetColor(Color color = null, long playerId = -1L)

Parameters

Type	Name	Description
Color	color
System.Int64	playerId

ScreenColorFadingStart(Single, Boolean, Int64)

Declaration

[VisualScriptingMiscData("Effects", "Fades/shows screen over period of time.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ScreenColorFadingStart(float time = 1F, bool toOpaque = true, long playerId = -1L)

Parameters

Type	Name	Description
System.Single	time
System.Boolean	toOpaque
System.Int64	playerId

ScreenColorFadingStartSwitch(Single, Int64)

Declaration

[VisualScriptingMiscData("Effects", "Switches screen fade state. Screen will un/fade over specified time.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ScreenColorFadingStartSwitch(float time = 1F, long playerId = -1L)

Parameters

Type	Name	Description
System.Single	time
System.Int64	playerId

SendChatMessage(String, String, Int64, String)

Declaration

[VisualScriptingMiscData("Notifications", "Sends a scripted chat message under name 'author' to all players (if playerId equal to 0), or to one specific player. In case of singleplayer, message will shown to local player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SendChatMessage(string message, string author = "", long playerId = 0L, string font = "Blue")

Parameters

Type	Name	Description
System.String	message
System.String	author
System.Int64	playerId
System.String	font

SendChatMessageColored(String, Color, String, Int64, String)

Declaration

[VisualScriptingMiscData("Notifications", "Sends a scripted chat message under name 'author' to all players (if playerId equal to 0), or to one specific player. In case of singleplayer, message will shown to local player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SendChatMessageColored(string message, Color color, string author = "", long playerId = 0L, string font = "White")

Parameters

Type	Name	Description
System.String	message
Color	color
System.String	author
System.Int64	playerId
System.String	font

SessionClose(Int32, Boolean, Boolean)

Declaration

[VisualScriptingMiscData("Gameplay", "Closes active session after the specific time (in ms).", -10510688)]
[VisualScriptingMember(true, false)]
public static void SessionClose(int fadeTimeMs = 10000, bool showCredits = true, bool closeSession = true)

Parameters

Type	Name	Description
System.Int32	fadeTimeMs
System.Boolean	showCredits
System.Boolean	closeSession

SessionExitGameDialog(String, String)

Declaration

[VisualScriptingMiscData("Gameplay", "Displays player the dialog to exit game to main menu (for non-campaign) or continue next campaign mission (for campaign).", -10510688)]
[VisualScriptingMember(true, false)]
public static void SessionExitGameDialog(string caption, string message)

Parameters

Type	Name	Description
System.String	caption
System.String	message

SessionReloadDialog(String, String, String)

Declaration

[VisualScriptingMiscData("Gameplay", "Displays reload dialog with specific caption and message to load save defined by path.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SessionReloadDialog(string caption, string message, string savePath = null)

Parameters

Type	Name	Description
System.String	caption
System.String	message
System.String	savePath

SessionReloadLastCheckpoint(Int32, String, Single, String)

Declaration

[VisualScriptingMiscData("Gameplay", "Reloads last checkpoint while displaying message on screen.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SessionReloadLastCheckpoint(int fadeTimeMs = 10000, string message = null, float textScale = 1F, string font = "Blue")

Parameters

Type	Name	Description
System.Int32	fadeTimeMs
System.String	message
System.Single	textScale
System.String	font

SetAllQuestlogDetailsCompleted(Boolean, Int64)

Declaration

[VisualScriptingMiscData("Questlog", "Sets completed on all quest details for the specified player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetAllQuestlogDetailsCompleted(bool completed = true, long playerId = -1L)

Parameters

Type	Name	Description
System.Boolean	completed
System.Int64	playerId

SetAllQuestlogDetailsCompletedLocal(Boolean, Int64)

Declaration

public static void SetAllQuestlogDetailsCompletedLocal(bool completed = true, long playerId = -1L)

Parameters

Type	Name	Description
System.Boolean	completed
System.Int64	playerId

SetAlphaHighlight(String, Boolean, Int32, Int32, Color, Int64, String, Single)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Enables/disables highlight of specific object for local player. You can set alpha of color too.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetAlphaHighlight(string entityName, bool enabled = true, int thickness = 10, int pulseTimeInFrames = 120, Color color = null, long playerId = -1L, string subPartNames = null, float alpha = 1F)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	enabled
System.Int32	thickness
System.Int32	pulseTimeInFrames
Color	color
System.Int64	playerId
System.String	subPartNames
System.Single	alpha

SetAlphaHighlightForAll(String, Boolean, Int32, Int32, Color, String, Single)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Enables/disables highlight of specific object for all players. You can set alpha of color too.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetAlphaHighlightForAll(string entityName, bool enabled = true, int thickness = 10, int pulseTimeInFrames = 120, Color color = null, string subPartNames = null, float alpha = 1F)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	enabled
System.Int32	thickness
System.Int32	pulseTimeInFrames
Color	color
System.String	subPartNames
System.Single	alpha

SetBlockCustomName(String, String)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Sets custom name of specific terminal block.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetBlockCustomName(string blockName, string newName)

Parameters

Type	Name	Description
System.String	blockName
System.String	newName

SetBlockEnabled(String, Boolean)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Enables/disables functional block.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetBlockEnabled(string blockName, bool enabled = true)

Parameters

Type	Name	Description
System.String	blockName
System.Boolean	enabled

SetBlockGeneralDamageModifier(String, Single)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Sets damage multiplier for specific block. (Value above 1 increase damage taken by the block, values in range <0;1> decrease damage taken. )", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetBlockGeneralDamageModifier(string blockName, float modifier = 1F)

Parameters

Type	Name	Description
System.String	blockName
System.Single	modifier

SetBlockHealth(String, Single, Boolean, Int64)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Sets block integrity to specific value in range <0;1>. 'damageChange' says if the change is treated as damage or repair (Build integrity won't change in case of damage). 'changeOwner' is id of the one who causes the change.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetBlockHealth(string entityName, float integrity = 1F, bool damageChange = true, long changeOwner = 0L)

Parameters

Type	Name	Description
System.String	entityName
System.Single	integrity
System.Boolean	damageChange
System.Int64	changeOwner

SetBlockShowInInventory(String, Boolean)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Sets whether or not terminal block should be shown in inventory terminal screen.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetBlockShowInInventory(string blockName, bool showInInventory = true)

Parameters

Type	Name	Description
System.String	blockName
System.Boolean	showInInventory

SetBlockShowInTerminal(String, Boolean)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Sets whether or not terminal block should be shown in terminal screen.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetBlockShowInTerminal(string blockName, bool showInTerminal = true)

Parameters

Type	Name	Description
System.String	blockName
System.Boolean	showInTerminal

SetBlockShowOnHUD(String, Boolean)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Sets whether or not terminal block should be seen in HUD.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetBlockShowOnHUD(string blockName, bool showOnHUD = true)

Parameters

Type	Name	Description
System.String	blockName
System.Boolean	showOnHUD

SetCampaignLevelOutcome(String)

Declaration

[VisualScriptingMiscData("Gameplay", "[Obsolete, use SetMissionOutcome] Sets the state of campaign. Necessary for transitions between missions in campaign.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetCampaignLevelOutcome(string outcome)

Parameters

Type	Name	Description
System.String	outcome

SetCell(String, String, String, String, Int64)

Declaration

[VisualScriptingMiscData("Board screen", "Set cell text in the board screen.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetCell(string boardId, string rowId, string columnId, string text, long playerId = -1L)

Parameters

Type	Name	Description
System.String	boardId
System.String	rowId
System.String	columnId
System.String	text
System.Int64	playerId

SetChatMaxMessageCount(Int32)

Declaration

[VisualScriptingMiscData("Notifications", "[Obsolete] Sets maximum count of messages in chat. [Has no effect anymore as whole history is being kept. Number of shown messages is dependant on number of rows they cover.]", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetChatMaxMessageCount(int count = 10)

Parameters

Type	Name	Description
System.Int32	count

SetChatMessageDuration(Int32)

Declaration

[VisualScriptingMiscData("Notifications", "Sets for how long chat messages should be shown before fading out.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetChatMessageDuration(int durationS = 10)

Parameters

Type	Name	Description
System.Int32	durationS

SetColumnVisibility(String, String, Boolean, Int64)

Declaration

[VisualScriptingMiscData("Board screen", "Set column visible state.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetColumnVisibility(string boardId, string columnId, bool visible, long playerId = -1L)

Parameters

Type	Name	Description
System.String	boardId
System.String	columnId
System.Boolean	visible
System.Int64	playerId

SetCustomLoadingScreenImage(String)

Declaration

[VisualScriptingMiscData("Misc", "Sets custom image for a loading screen.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetCustomLoadingScreenImage(string imagePath)

Parameters

Type	Name	Description
System.String	imagePath

SetCustomLoadingScreenText(String)

Declaration

[VisualScriptingMiscData("Misc", "Sets custom loading text for a loading screen", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetCustomLoadingScreenText(string text)

Parameters

Type	Name	Description
System.String	text

SetCustomSkybox(String)

Declaration

[VisualScriptingMiscData("Misc", "Sets custom skybox for the current game.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetCustomSkybox(string skyboxPath)

Parameters

Type	Name	Description
System.String	skyboxPath

SetDampenersEnabled(String, Boolean)

Declaration

[VisualScriptingMiscData("Entity", "Turns dampeners of specific entity on/off.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetDampenersEnabled(string entityName, bool state)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	state

SetDisabledByExperimental(MyGuiControlBase)

Declaration

public static void SetDisabledByExperimental(this MyGuiControlBase control)

Parameters

Type	Name	Description
Sandbox.Graphics.GUI.MyGuiControlBase	control

SetDroneBehaviourAdvanced(String, String, Boolean, Boolean, List<MyEntity>, Boolean, List<MyEntity>)

Declaration

[VisualScriptingMiscData("AI", "Adds specific drone behavior from preset to a drone. (Extended parameters)", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetDroneBehaviourAdvanced(string entityName, string presetName = "Default", bool activate = true, bool assignToPirates = true, List<MyEntity> waypoints = null, bool cycleWaypoints = false, List<MyEntity> targets = null)

Parameters

Type	Name	Description
System.String	entityName
System.String	presetName
System.Boolean	activate
System.Boolean	assignToPirates
System.Collections.Generic.List<MyEntity>	waypoints
System.Boolean	cycleWaypoints
System.Collections.Generic.List<MyEntity>	targets

SetDroneBehaviourBasic(String, String)

Declaration

[VisualScriptingMiscData("AI", "Adds specific drone behavior from preset to a drone. (Reduced parameters)", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetDroneBehaviourBasic(string entityName, string presetName = "Default")

Parameters

Type	Name	Description
System.String	entityName
System.String	presetName

SetDroneBehaviourFull(String, String, Boolean, Boolean, List<MyEntity>, Boolean, List<MyEntity>, Int32, Single, TargetPrioritization)

Declaration

[VisualScriptingMiscData("AI", "Adds specific drone behavior from preset to a drone. (Full parameters)", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetDroneBehaviourFull(string entityName, string presetName = "Default", bool activate = true, bool assignToPirates = true, List<MyEntity> waypoints = null, bool cycleWaypoints = false, List<MyEntity> targets = null, int playerPriority = 10, float maxPlayerDistance = 10000F, TargetPrioritization prioritizationStyle)

Parameters

Type	Name	Description
System.String	entityName
System.String	presetName
System.Boolean	activate
System.Boolean	assignToPirates
System.Collections.Generic.List<MyEntity>	waypoints
System.Boolean	cycleWaypoints
System.Collections.Generic.List<MyEntity>	targets
System.Int32	playerPriority
System.Single	maxPlayerDistance
VRage.Game.ObjectBuilders.AI.TargetPrioritization	prioritizationStyle

SetEnabledByExperimental(MyGuiControlBase)

Declaration

public static void SetEnabledByExperimental(this MyGuiControlBase control)

Parameters

Type	Name	Description
Sandbox.Graphics.GUI.MyGuiControlBase	control

SetEntityPosition(String, Vector3D)

Declaration

[VisualScriptingMiscData("Entity", "Sets world position of specific entity.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetEntityPosition(string entityName, Vector3D position)

Parameters

Type	Name	Description
System.String	entityName
Vector3D	position

SetFactionObjectivePercentageCompleted(Int64, Single)

Declaration

[VisualScriptingMiscData("GUI", "Changes escape pod finished percentage in scoreCounter.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetFactionObjectivePercentageCompleted(long factionId, float finished)

Parameters

Type	Name	Description
System.Int64	factionId
System.Single	finished

SetFactionScore(Int64, Int32)

Declaration

[VisualScriptingMiscData("GUI", "Changes faction Score", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetFactionScore(long factionId, int score)

Parameters

Type	Name	Description
System.Int64	factionId
System.Int32	score

SetGPSColor(String, Color, Int64)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Sets color of GPS for specific player. If 'playerId' is less or equal to 0, GPS will be modified for local player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGPSColor(string name, Color newColor, long playerId = -1L)

Parameters

Type	Name	Description
System.String	name
Color	newColor
System.Int64	playerId

SetGPSHighlight(String, String, String, Color, Boolean, Int32, Int32, Color, Int64, String)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Enables/disables highlight for specific entity and creates/deletes GPS attached to it. For local player only.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGPSHighlight(string entityName, string GPSName, string GPSDescription, Color GPSColor, bool enabled = true, int thickness = 10, int pulseTimeInFrames = 120, Color color = null, long playerId = -1L, string subPartNames = null)

Parameters

Type	Name	Description
System.String	entityName
System.String	GPSName
System.String	GPSDescription
Color	GPSColor
System.Boolean	enabled
System.Int32	thickness
System.Int32	pulseTimeInFrames
Color	color
System.Int64	playerId
System.String	subPartNames

SetGPSHighlightForAll(String, String, String, Color, Boolean, Int32, Int32, Color, String)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Enables/disables highlight for specific entity and creates/deletes GPS attached to it. For all players.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGPSHighlightForAll(string entityName, string GPSName, string GPSDescription, Color GPSColor, bool enabled = true, int thickness = 10, int pulseTimeInFrames = 120, Color color = null, string subPartNames = null)

Parameters

Type	Name	Description
System.String	entityName
System.String	GPSName
System.String	GPSDescription
Color	GPSColor
System.Boolean	enabled
System.Int32	thickness
System.Int32	pulseTimeInFrames
Color	color
System.String	subPartNames

SetGPSHighlightNoSound(String, String, String, Color, Boolean, Int32, Int32, Color, Int64, String)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Enables/disables highlight for specific entity and creates/deletes GPS attached to it. For local player only.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGPSHighlightNoSound(string entityName, string GPSName, string GPSDescription, Color GPSColor, bool enabled = true, int thickness = 10, int pulseTimeInFrames = 120, Color color = null, long playerId = -1L, string subPartNames = null)

Parameters

Type	Name	Description
System.String	entityName
System.String	GPSName
System.String	GPSDescription
Color	GPSColor
System.Boolean	enabled
System.Int32	thickness
System.Int32	pulseTimeInFrames
Color	color
System.Int64	playerId
System.String	subPartNames

SetGPSHighlightNoSoundForAll(String, String, String, Color, Boolean, Int32, Int32, Color, String)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Enables/disables highlight for specific entity and creates/deletes GPS attached to it. For all players.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGPSHighlightNoSoundForAll(string entityName, string GPSName, string GPSDescription, Color GPSColor, bool enabled = true, int thickness = 10, int pulseTimeInFrames = 120, Color color = null, string subPartNames = null)

Parameters

Type	Name	Description
System.String	entityName
System.String	GPSName
System.String	GPSDescription
Color	GPSColor
System.Boolean	enabled
System.Int32	thickness
System.Int32	pulseTimeInFrames
Color	color
System.String	subPartNames

SetGridBlocksEnabled(String, Boolean)

Declaration

[VisualScriptingMiscData("Grid", "Enables/disables all functional blocks on the specified grid.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGridBlocksEnabled(string gridName, bool enabled = true)

Parameters

Type	Name	Description
System.String	gridName
System.Boolean	enabled

SetGridBlocksShowInInventory(String, Boolean)

Declaration

[VisualScriptingMiscData("Grid", "Sets all terminal blocks of specified grid to be (not) shown in inventory screen.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGridBlocksShowInInventory(string gridName, bool showInInventory = true)

Parameters

Type	Name	Description
System.String	gridName
System.Boolean	showInInventory

SetGridBlocksShowInTerminal(String, Boolean)

Declaration

[VisualScriptingMiscData("Grid", "Sets all terminal blocks of specified grid to be (not) shown in terminal screen.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGridBlocksShowInTerminal(string gridName, bool showInTerminal = true)

Parameters

Type	Name	Description
System.String	gridName
System.Boolean	showInTerminal

SetGridBlocksShowOnHUD(String, Boolean)

Declaration

[VisualScriptingMiscData("Grid", "Sets all terminal blocks of specified grid to be (not) shown on HUD.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGridBlocksShowOnHUD(string gridName, bool showOnHUD = true)

Parameters

Type	Name	Description
System.String	gridName
System.Boolean	showOnHUD

SetGridDestructible(String, Boolean)

Declaration

[VisualScriptingMiscData("Grid", "Un/Marks the specific grid as destructible. Such grid cannot be destroyed, but can be grinded", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGridDestructible(string entityName, bool destructible = true)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	destructible

SetGridEditable(String, Boolean)

Declaration

[VisualScriptingMiscData("Grid", "Un/Marks the specific grid as editable.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGridEditable(string entityName, bool editable = true)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	editable

SetGridGeneralDamageModifier(String, Single)

Declaration

[VisualScriptingMiscData("Grid", "Sets grid general damage modifier that multiplies all damage received by that grid.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGridGeneralDamageModifier(string gridName, float modifier = 1F)

Parameters

Type	Name	Description
System.String	gridName
System.Single	modifier

SetGridImmune(String, Boolean)

Declaration

[VisualScriptingMiscData("Grid", "Un/Marks the specific grid as immune. Such grid cannot be destroyed or grinded.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGridImmune(string entityName, bool immune = true)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	immune

SetGridLandingGearsLock(String, Boolean)

Declaration

[VisualScriptingMiscData("Grid", "Sets state of Landing gears for whole grid.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGridLandingGearsLock(string gridName, bool gearLock = true)

Parameters

Type	Name	Description
System.String	gridName
System.Boolean	gearLock

SetGridPowerState(String, Boolean)

Declaration

[VisualScriptingMiscData("Grid", "Sets grid's power state.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGridPowerState(string gridName, bool enabled)

Parameters

Type	Name	Description
System.String	gridName
System.Boolean	enabled

SetGridPowerStateByPlayer(String, Boolean, Int64)

Declaration

[VisualScriptingMiscData("Grid", "Sets grid's power state by the specified player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGridPowerStateByPlayer(string gridName, bool enabled, long playerId)

Parameters

Type	Name	Description
System.String	gridName
System.Boolean	enabled
System.Int64	playerId

SetGridReactors(String, Boolean)

Declaration

[VisualScriptingMiscData("Grid", "Turns reactors of specific grid on/off.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGridReactors(string gridName, bool turnOn = true)

Parameters

Type	Name	Description
System.String	gridName
System.Boolean	turnOn

SetGridStatic(String, Boolean)

Declaration

[VisualScriptingMiscData("Grid", "Sets the specific grid as static/dynamic.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGridStatic(string gridName, bool isStatic = true)

Parameters

Type	Name	Description
System.String	gridName
System.Boolean	isStatic

SetGridWeaponStatus(String, Boolean)

Declaration

[VisualScriptingMiscData("Grid", "Enables/disables all weapons(MyUserControllableGun) on the specific grid.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetGridWeaponStatus(string gridName, bool enabled = true)

Parameters

Type	Name	Description
System.String	gridName
System.Boolean	enabled

SetHighlight(String, Boolean, Int32, Int32, Color, Int64, String)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Enables/disables highlight of specific object for local player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetHighlight([Nullable] string entityName, bool enabled = true, int thickness = 10, int pulseTimeInFrames = 120, Color color = null, long playerId = -1L, [Nullable] string subPartNames = null)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	enabled
System.Int32	thickness
System.Int32	pulseTimeInFrames
Color	color
System.Int64	playerId
System.String	subPartNames

SetHighlight(MyHighlightData, Int64)

Declaration

public static void SetHighlight(MyHighlightData highlightData, long playerId)

Parameters

Type	Name	Description
VRage.Game.ObjectBuilders.Gui.MyHighlightData	highlightData
System.Int64	playerId

SetHighlightForAll(String, Boolean, Int32, Int32, Color, String)

Declaration

[VisualScriptingMiscData("GPS and Highlights", "Enables/disables highlight of specific object for all players.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetHighlightForAll(string entityName, bool enabled = true, int thickness = 10, int pulseTimeInFrames = 120, Color color = null, string subPartNames = null)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	enabled
System.Int32	thickness
System.Int32	pulseTimeInFrames
Color	color
System.String	subPartNames

SetHighlightForProjection(String, Boolean, Int32, Int32, Color, Int64)

Declaration

[VisualScriptingMiscData("Grid", "Sets projection highlight for the specific projector block.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetHighlightForProjection(string projectorName, bool enabled = true, int thickness = 5, int pulseTimeInFrames = 120, Color color = null, long playerId = -1L)

Parameters

Type	Name	Description
System.String	projectorName
System.Boolean	enabled
System.Int32	thickness
System.Int32	pulseTimeInFrames
Color	color
System.Int64	playerId

SetHighlightLocal(String, Int32, Int32, Color, Int64, String)

Declaration

public static void SetHighlightLocal(string entityName, int thickness = 10, int pulseTimeInFrames = 120, Color color = null, long playerId = -1L, string subPartNames = null)

Parameters

Type	Name	Description
System.String	entityName
System.Int32	thickness
System.Int32	pulseTimeInFrames
Color	color
System.Int64	playerId
System.String	subPartNames

SetHudState(Int32, Int64)

Declaration

[VisualScriptingMiscData("Effects", "Set state of HUD to specific state. 0 - minimal hud.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetHudState(int state = 0, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	state
System.Int64	playerId

SetLandingGearLock(String, Boolean)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Sets lock state of specific Landing gear.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetLandingGearLock(string entityName, bool locked = true)

Parameters

Type	Name	Description
System.String	entityName
System.Boolean	locked

SetLigtingBlockColor(String, Color)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Sets color of specific Lighting block.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetLigtingBlockColor(string lightBlockName, Color color)

Parameters

Type	Name	Description
System.String	lightBlockName
Color	color

SetLigtingBlockIntensity(String, Single)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Sets intensity of specific Lighting block.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetLigtingBlockIntensity(string lightBlockName, float intensity)

Parameters

Type	Name	Description
System.String	lightBlockName
System.Single	intensity

SetLigtingBlockRadius(String, Single)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Sets radius of specific Lighting block.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetLigtingBlockRadius(string lightBlockName, float radius)

Parameters

Type	Name	Description
System.String	lightBlockName
System.Single	radius

SetMatchIsRunningState(Boolean)

Declaration

[VisualScriptingMiscData("Other", "Sets whether match component should be runing or not. When component is running, remaining time of the state will be ticking out and states will be changing. If component is not running, it will be effectively paused until running again.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetMatchIsRunningState(bool isRunning)

Parameters

Type	Name	Description
System.Boolean	isRunning

SetMatchStateRemainingDuration(Single)

Declaration

[VisualScriptingMiscData("Other", "Set remaining time of the current match state. Time is in minutes. If the value is lower or equal to zero, next match phase will start.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetMatchStateRemainingDuration(float time)

Parameters

Type	Name	Description
System.Single	time

SetMissionOutcome(String)

Declaration

[VisualScriptingMiscData("Gameplay", "Sets the state of the mission. Necessary for transitions between missions in the scenario.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetMissionOutcome(string outcome = "Mission Complete")

Parameters

Type	Name	Description
System.String	outcome

SetName(Int64, String)

Declaration

[VisualScriptingMiscData("Entity", "Gets name of specific entity defined by id.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetName(long entityId, string name)

Parameters

Type	Name	Description
System.Int64	entityId
System.String	name

SetPage(MyGuiControlTabControl, Int32)

Declaration

[VisualScriptingMiscData("GUI", "Changes selected page of TabControl element to specific page.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetPage(this MyGuiControlTabControl pageControl, int pageNumber)

Parameters

Type	Name	Description
Sandbox.Graphics.GUI.MyGuiControlTabControl	pageControl
System.Int32	pageNumber

SetPlayerGeneralDamageModifier(Int64, Single)

Declaration

[VisualScriptingMiscData("Player", "Sets player's damage modifier.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetPlayerGeneralDamageModifier(long playerId = 0L, float modifier = 1F)

Parameters

Type	Name	Description
System.Int64	playerId
System.Single	modifier

SetPlayerInputBlacklistState(String, Int64, Boolean)

Declaration

[VisualScriptingMiscData("Player", "Sets player's input black list. Enables/Disables specified control of the character.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetPlayerInputBlacklistState(string controlStringId, long playerId = -1L, bool enabled = false)

Parameters

Type	Name	Description
System.String	controlStringId
System.Int64	playerId
System.Boolean	enabled

SetPlayersColorInHSV(Int64, Vector3)

Declaration

[VisualScriptingMiscData("Player", "Sets player's color (HSV).", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetPlayersColorInHSV(long playerId = 0L, Vector3 colorHSV = null)

Parameters

Type	Name	Description
System.Int64	playerId
Vector3	colorHSV

SetPlayersColorInRGB(Int64, Color)

Declaration

[VisualScriptingMiscData("Player", "Sets player's color (RGB).", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetPlayersColorInRGB(long playerId = 0L, Color colorRBG = null)

Parameters

Type	Name	Description
System.Int64	playerId
Color	colorRBG

SetPlayersEnergyLevel(Int64, Single)

Declaration

[VisualScriptingMiscData("Player", "Sets energy level of the player's suit.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetPlayersEnergyLevel(long playerId = 0L, float value = 1F)

Parameters

Type	Name	Description
System.Int64	playerId
System.Single	value

SetPlayersFaction(Int64, String)

Declaration

[VisualScriptingMiscData("Factions", "Forces join player into a faction specified by tag. Returns false if faction does not exist, true otherwise. If player was in any faction before, he will be removed from that faction.", -10510688)]
[VisualScriptingMember(true, false)]
public static bool SetPlayersFaction(long playerId = 0L, string factionTag = "")

Parameters

Type	Name	Description
System.Int64	playerId
System.String	factionTag

Returns

Type	Description
System.Boolean

SetPlayersHealth(Int64, Single)

Declaration

[VisualScriptingMiscData("Player", "Sets player's health.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetPlayersHealth(long playerId = 0L, float value = 100F)

Parameters

Type	Name	Description
System.Int64	playerId
System.Single	value

SetPlayersHelmetStatus(Int64, Boolean)

Declaration

[VisualScriptingMiscData("Player", "Sets player's helmet status.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetPlayersHelmetStatus(long playerId = 0L, bool status = true)

Parameters

Type	Name	Description
System.Int64	playerId
System.Boolean	status

SetPlayersHydrogenLevel(Int64, Single)

Declaration

[VisualScriptingMiscData("Player", "Sets hydrogen level of the player's suit.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetPlayersHydrogenLevel(long playerId = 0L, float value = 1F)

Parameters

Type	Name	Description
System.Int64	playerId
System.Single	value

SetPlayersOxygenLevel(Int64, Single)

Declaration

[VisualScriptingMiscData("Player", "Sets oxygen level of the player's suit.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetPlayersOxygenLevel(long playerId = 0L, float value = 1F)

Parameters

Type	Name	Description
System.Int64	playerId
System.Single	value

SetPlayersPosition(Int64, Vector3D)

Declaration

[VisualScriptingMiscData("Player", "Sets player's position.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetPlayersPosition(long playerId = 0L, Vector3D position = null)

Parameters

Type	Name	Description
System.Int64	playerId
Vector3D	position

SetPlayersSpeed(Vector3D, Int64)

Declaration

[VisualScriptingMiscData("Player", "Sets player's speed (linear velocity).", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetPlayersSpeed(Vector3D speed = null, long playerId = 0L)

Parameters

Type	Name	Description
Vector3D	speed
System.Int64	playerId

SetQuestlog(Boolean, String, Int64)

Declaration

[VisualScriptingMiscData("Questlog", "Sets title and visibility of the quest for the specified player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetQuestlog(bool visible = true, string questName = "", long playerId = -1L)

Parameters

Type	Name	Description
System.Boolean	visible
System.String	questName
System.Int64	playerId

SetQuestlogDetailCompleted(Int32, Boolean, Int64)

Declaration

[VisualScriptingMiscData("Questlog", "Sets completed of the quest detail for the specified player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetQuestlogDetailCompleted(int lineId = 0, bool completed = true, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	lineId
System.Boolean	completed
System.Int64	playerId

SetQuestlogDetailCompletedLocal(Int32, Boolean, Int64)

Declaration

public static void SetQuestlogDetailCompletedLocal(int lineId = 0, bool completed = true, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	lineId
System.Boolean	completed
System.Int64	playerId

SetQuestlogLocal(Boolean, String, Int64)

Declaration

public static void SetQuestlogLocal(bool visible = true, string questName = "", long playerId = -1L)

Parameters

Type	Name	Description
System.Boolean	visible
System.String	questName
System.Int64	playerId

SetQuestlogPage(Int32, Int64)

Declaration

[VisualScriptingMiscData("Questlog", "Obsolete. Does not do anything.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetQuestlogPage(int value = 0, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	value
System.Int64	playerId

SetQuestlogTitle(String, Int64)

Declaration

[VisualScriptingMiscData("Questlog", "Sets title of the quest for the specified player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetQuestlogTitle(string questName = "", long playerId = -1L)

Parameters

Type	Name	Description
System.String	questName
System.Int64	playerId

SetQuestlogTitleLocal(String, Int64)

Declaration

public static void SetQuestlogTitleLocal(string questName = "", long playerId = -1L)

Parameters

Type	Name	Description
System.String	questName
System.Int64	playerId

SetQuestlogVisible(Boolean, Int64)

Declaration

[VisualScriptingMiscData("Questlog", "Sets visible of the quest for the specified player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetQuestlogVisible(bool value = true, long playerId = -1L)

Parameters

Type	Name	Description
System.Boolean	value
System.Int64	playerId

SetQuestlogVisibleLocal(Boolean, Int64)

Declaration

public static void SetQuestlogVisibleLocal(bool value = true, long playerId = -1L)

Parameters

Type	Name	Description
System.Boolean	value
System.Int64	playerId

SetRelationBetweenFactions(String, String, Int32)

Declaration

[VisualScriptingMiscData("Factions", "Set reputation between two factions. Reputation will be automatically clamped to allwed range.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetRelationBetweenFactions(string tagA, string tagB, int reputation)

Parameters

Type	Name	Description
System.String	tagA
System.String	tagB
System.Int32	reputation

SetRelationBetweenPlayerAndFaction(Int64, String, Int32)

Declaration

[VisualScriptingMiscData("Factions", "Set reputation between player and faction. Reputation will be automatically clamped to allwed range.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetRelationBetweenPlayerAndFaction(long playerId, string tagB, int reputation)

Parameters

Type	Name	Description
System.Int64	playerId
System.String	tagB
System.Int32	reputation

SetRowRanking(String, String, Int32, Int64)

Declaration

[VisualScriptingMiscData("Board screen", "Set row ranking used for sorting.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetRowRanking(string boardId, string rowId, int ranking, long playerId = -1L)

Parameters

Type	Name	Description
System.String	boardId
System.String	rowId
System.Int32	ranking
System.Int64	playerId

SetScenarioWinTypeForAnalytics(String)

Declaration

[VisualScriptingMiscData("Other", "Set type of scenario win for analytics", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetScenarioWinTypeForAnalytics(string winType)

Parameters

Type	Name	Description
System.String	winType

SetTextPanelColors(String, Color, Color)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Sets colors of specific Text panel.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetTextPanelColors(string panelName, Color fontColor, Color backgroundColor)

Parameters

Type	Name	Description
System.String	panelName
Color	fontColor
Color	backgroundColor

SetTextPanelDescription(String, String, Boolean)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Sets description of specific Text panel.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetTextPanelDescription(string panelName, string description, bool publicDescription = true)

Parameters

Type	Name	Description
System.String	panelName
System.String	description
System.Boolean	publicDescription

SetTextPanelTitle(String, String, Boolean)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Sets title of specific Text panel.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetTextPanelTitle(string panelName, string title, bool publicTitle = true)

Parameters

Type	Name	Description
System.String	panelName
System.String	title
System.Boolean	publicTitle

SetToolbarPage(Int32, Int64)

Declaration

[VisualScriptingMiscData("Toolbar", "Sets the specified page for the toolbar.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetToolbarPage(int page, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	page
System.Int64	playerId

SetToolbarPageLocal(Int32, Int64)

Declaration

public static void SetToolbarPageLocal(int page, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	page
System.Int64	playerId

SetToolbarSlotToItem(Int32, MyDefinitionId, Int64)

Declaration

[VisualScriptingMiscData("Toolbar", "Sets item to the specified slot for the player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetToolbarSlotToItem(int slot, MyDefinitionId itemId, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	slot
MyDefinitionId	itemId
System.Int64	playerId

SetToolbarSlotToItemLocal(Int32, SerializableDefinitionId, Int64)

Declaration

public static void SetToolbarSlotToItemLocal(int slot, SerializableDefinitionId itemId, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	slot
SerializableDefinitionId	itemId
System.Int64	playerId

SetToolbarSlotToItemSync(Int32, SerializableDefinitionId, Int64)

Declaration

[Event(null, 7862)]
[Reliable]
[ServerInvoked]
[Broadcast]
public static void SetToolbarSlotToItemSync(int slot, SerializableDefinitionId itemId, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	slot
SerializableDefinitionId	itemId
System.Int64	playerId

SetTooltip(MyGuiControlBase, String)

Declaration

[VisualScriptingMiscData("GUI", "Sets tooltip of specific GUI element.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetTooltip(this MyGuiControlBase control, string text)

Parameters

Type	Name	Description
Sandbox.Graphics.GUI.MyGuiControlBase	control
System.String	text

SetVolume(Single, Single, Single)

Declaration

[VisualScriptingMiscData("Audio", "Set volume for game audio. Use -1 for no change. 0 min, 1 max.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetVolume(float gameVolume = -1F, float musicVolume = -1F, float voiceChatVolume = -1F)

Parameters

Type	Name	Description
System.Single	gameVolume
System.Single	musicVolume
System.Single	voiceChatVolume

SetVolumeLocal(Single, Single, Single)

Declaration

public static void SetVolumeLocal(float gameVolume = -1F, float musicVolume = -1F, float voiceChatVolume = -1F)

Parameters

Type	Name	Description
System.Single	gameVolume
System.Single	musicVolume
System.Single	voiceChatVolume

SetWeatherC(String, String, Single)

Declaration

[VisualScriptingMiscData("Environment", "Set weather based on character position", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetWeatherC(string weatherCommand, string weatherEffect, float radius)

Parameters

Type	Name	Description
System.String	weatherCommand
System.String	weatherEffect
System.Single	radius

SetWeatherP(String, String, Single, Vector3D)

Declaration

[VisualScriptingMiscData("Environment", "Set weather based on exact position", -10510688)]
[VisualScriptingMember(true, false)]
public static void SetWeatherP(string weatherCommand, string weatherEffect, float radius, Vector3D position)

Parameters

Type	Name	Description
System.String	weatherCommand
System.String	weatherEffect
System.Single	radius
Vector3D	position

ShowHud(Boolean, Int64)

Declaration

[VisualScriptingMiscData("Effects", "False to force minimize HUD, true to disable force minimization. (Force minimization overrides HUD state without actually changing it so you can revert back safely.)", -10510688)]
[VisualScriptingMember(true, false)]
public static void ShowHud(bool flag = true, long playerId = -1L)

Parameters

Type	Name	Description
System.Boolean	flag
System.Int64	playerId

ShowNotification(String, Int32, String, Int64)

Declaration

[VisualScriptingMiscData("Notifications", "Shows a notification with specific message and font for the specific player for a defined time. If playerId is equal to 0, notification will be show to local player, otherwise it will be shown to specific player. If playerId is -1, notification is shown to all players.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ShowNotification(string message, int disappearTimeMs, string font = "White", long playerId = 0L)

Parameters

Type	Name	Description
System.String	message
System.Int32	disappearTimeMs
System.String	font
System.Int64	playerId

ShowNotificationLocal(String, Int32, String)

Declaration

public static void ShowNotificationLocal(string message, int disappearTimeMs, string font = "White")

Parameters

Type	Name	Description
System.String	message
System.Int32	disappearTimeMs
System.String	font

ShowNotificationToAll(String, Int32, String)

Declaration

[VisualScriptingMiscData("Notifications", "Shows a notification with specific message and font to all players for a defined time.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ShowNotificationToAll(string message, int disappearTimeMs, string font = "White")

Parameters

Type	Name	Description
System.String	message
System.Int32	disappearTimeMs
System.String	font

ShowOrderInColumn(String, String, Int64)

Declaration

[VisualScriptingMiscData("Board screen", "Set row ranking used for sorting.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ShowOrderInColumn(string boardId, string columnId, long playerId = -1L)

Parameters

Type	Name	Description
System.String	boardId
System.String	columnId
System.Int64	playerId

SkinBlock(String, String)

Declaration

[VisualScriptingMiscData("Blocks Generic", "Sets skin of specific block.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SkinBlock(string blockName, string skin)

Parameters

Type	Name	Description
System.String	blockName
System.String	skin

SkipCutscene(Int64)

Declaration

[VisualScriptingMiscData("Cutscenes", "Skips current cutscene. If 'playerId' is -1, apply for all players, otherwise only for specific player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SkipCutscene(long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	playerId

SkipCutsceneLocal(Int64)

Declaration

public static void SkipCutsceneLocal(long playerId = -1L)

Parameters

Type	Name	Description
System.Int64	playerId

SortByColumn(String, String, Boolean, Int64)

Declaration

[VisualScriptingMiscData("Board screen", "Set row ranking used for sorting.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SortByColumn(string boardId, string columnId, bool ascending, long playerId = -1L)

Parameters

Type	Name	Description
System.String	boardId
System.String	columnId
System.Boolean	ascending
System.Int64	playerId

SortByRanking(String, Boolean, Int64)

Declaration

[VisualScriptingMiscData("Board screen", "Set row ranking used for sorting.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SortByRanking(string boardId, bool ascending, long playerId = -1L)

Parameters

Type	Name	Description
System.String	boardId
System.Boolean	ascending
System.Int64	playerId

SpawnBot(String, Vector3D)

Declaration

[VisualScriptingMiscData("Spawn", "Spawns the bot at the specified position.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SpawnBot(string subtypeName, Vector3D position)

Parameters

Type	Name	Description
System.String	subtypeName
Vector3D	position

SpawnBot(String, Vector3D, Vector3D, Vector3D, String)

Declaration

[VisualScriptingMiscData("Spawn", "Spawns the bot at the specified position, orientation and specific data.", -10510688)]
[VisualScriptingMember(true, false)]
public static long SpawnBot(string subtypeName, Vector3D position, Vector3D direction, Vector3D up, string name)

Parameters

Type	Name	Description
System.String	subtypeName
Vector3D	position
Vector3D	direction
Vector3D	up
System.String	name

Returns

Type	Description
System.Int64

SpawnGroup(String, Vector3D, Vector3D, Vector3D, Int64, String)

Declaration

[VisualScriptingMiscData("Spawn", "Spawns the group of prefabs at the specified position.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SpawnGroup(string subtypeId, Vector3D position, Vector3D direction, Vector3D up, long ownerId = 0L, string newGridName = null)

Parameters

Type	Name	Description
System.String	subtypeId
Vector3D	position
Vector3D	direction
Vector3D	up
System.Int64	ownerId
System.String	newGridName

SpawnItem(MyDefinitionId, Vector3D, String, Single)

Declaration

[VisualScriptingMiscData("Spawn", "Spawns the item at the specified position.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SpawnItem(MyDefinitionId itemId, Vector3D position, string inheritsVelocityFrom = "", float amount = 1F)

Parameters

Type	Name	Description
MyDefinitionId	itemId
Vector3D	position
System.String	inheritsVelocityFrom
System.Single	amount

SpawnLocalBlueprint(String, Vector3D, Vector3D, String, Int64)

Declaration

[VisualScriptingMiscData("Spawn", "Spawns local blueprint at the specified position.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SpawnLocalBlueprint(string name, Vector3D position, Vector3D direction = null, string newGridName = null, long ownerId = 0L)

Parameters

Type	Name	Description
System.String	name
Vector3D	position
Vector3D	direction
System.String	newGridName
System.Int64	ownerId

SpawnLocalBlueprintInGravity(String, Vector3D, Single, Single, String, Int64)

Declaration

[VisualScriptingMiscData("Spawn", "Spawns local blueprint at the specified position and aligned to gravity.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SpawnLocalBlueprintInGravity(string name, Vector3D position, float rotationAngle = 0F, float gravityOffset = 0F, string newGridName = null, long ownerId = 0L)

Parameters

Type	Name	Description
System.String	name
Vector3D	position
System.Single	rotationAngle
System.Single	gravityOffset
System.String	newGridName
System.Int64	ownerId

SpawnPlayer(MatrixD, Vector3D, Int64)

Declaration

[VisualScriptingMiscData("Player", "Spawns player on the specified position.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SpawnPlayer(MatrixD worldMatrix, Vector3D velocity = null, long playerId = 0L)

Parameters

Type	Name	Description
MatrixD	worldMatrix
Vector3D	velocity
System.Int64	playerId

SpawnPrefab(String, Vector3D, Vector3D, Vector3D, Int64, String, String, SpawningOptions)

Declaration

[VisualScriptingMiscData("Spawn", "Spawns the prefab at the specified position.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SpawnPrefab(string prefabName, Vector3D position, Vector3D direction, Vector3D up, long ownerId = 0L, string beaconName = null, string entityName = null, SpawningOptions spawningOptions)

Parameters

Type	Name	Description
System.String	prefabName
Vector3D	position
Vector3D	direction
Vector3D	up
System.Int64	ownerId
System.String	beaconName
System.String	entityName
SpawningOptions	spawningOptions

SpawnPrefabInGravity(String, Vector3D, Vector3D, Int64, String, String, Single, Single, SpawningOptions)

Declaration

[VisualScriptingMiscData("Spawn", "Spawns the prefab at the specified position aligned to gravity.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SpawnPrefabInGravity(string prefabName, Vector3D position, Vector3D direction, long ownerId = 0L, string beaconName = null, string entityName = null, float gravityOffset = 0F, float gravityRotation = 0F, SpawningOptions spawningOptions)

Parameters

Type	Name	Description
System.String	prefabName
Vector3D	position
Vector3D	direction
System.Int64	ownerId
System.String	beaconName
System.String	entityName
System.Single	gravityOffset
System.Single	gravityRotation
SpawningOptions	spawningOptions

StartCutscene(String, Boolean, Int64)

Declaration

[VisualScriptingMiscData("Cutscenes", "Starts specific cutscene. If 'playerId' is -1, apply for all players, otherwise only for specific player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StartCutscene(string cutsceneName, bool registerEvents = true, long playerId = -1L)

Parameters

Type	Name	Description
System.String	cutsceneName
System.Boolean	registerEvents
System.Int64	playerId

StartCutsceneLocal(String, Boolean, Int64)

Declaration

public static void StartCutsceneLocal(string cutsceneName, bool registerEvents = true, long playerId = -1L)

Parameters

Type	Name	Description
System.String	cutsceneName
System.Boolean	registerEvents
System.Int64	playerId

StartGameplayTimer(String, Boolean)

Declaration

[VisualScriptingMiscData("Timers", "Start a timer with a specified key.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StartGameplayTimer(string key, bool reset)

Parameters

Type	Name	Description
System.String	key
System.Boolean	reset

StartStateMachine(String, Int64)

Declaration

[VisualScriptingMiscData("State Machines", "Starts the specified state machine.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StartStateMachine(string stateMachineName, long ownerId = 0L)

Parameters

Type	Name	Description
System.String	stateMachineName
System.Int64	ownerId

StartTimerBlock(String)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Calls 'Start' action on specific functional block.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StartTimerBlock(string blockName)

Parameters

Type	Name	Description
System.String	blockName

StopDedicatedServer()

Declaration

[VisualScriptingMember(true, false)]
[VisualScriptingMiscData("Gameplay", "Stop dedicated server (autorestart if enabled).", -10510688)]
public static void StopDedicatedServer()

StopGameplayTimer(String, Boolean)

Declaration

[VisualScriptingMiscData("Timers", "Stop timer running.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StopGameplayTimer(string key, bool reset = false)

Parameters

Type	Name	Description
System.String	key
System.Boolean	reset

StopSound(String, Boolean)

Declaration

[VisualScriptingMiscData("Audio", "Stops sound played by specific emitter.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StopSound([Nullable] string emitterId, bool forced = false)

Parameters

Type	Name	Description
System.String	emitterId
System.Boolean	forced

StopSoundLocal(String, Boolean)

Declaration

public static void StopSoundLocal(string emitterId, bool forced = false)

Parameters

Type	Name	Description
System.String	emitterId
System.Boolean	forced

StopTimerBlock(String)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Calls 'Stop' action on specific functional block.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StopTimerBlock(string blockName)

Parameters

Type	Name	Description
System.String	blockName

StoreEntityBool(String, String, Boolean)

Declaration

[VisualScriptingMiscData("Entity Storage", "Stores boolean in the entity storage. This value is accessible from all scripts.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StoreEntityBool(string entityName, string key, bool value)

Parameters

Type	Name	Description
System.String	entityName
System.String	key
System.Boolean	value

StoreEntityBoolList(String, String, List<Boolean>)

Declaration

[VisualScriptingMiscData("Entity Storage", "Stores boolean list in the entity storage. This value is accessible from all scripts.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StoreEntityBoolList(string entityName, string key, List<bool> value)

Parameters

Type	Name	Description
System.String	entityName
System.String	key
System.Collections.Generic.List<System.Boolean>	value

StoreEntityFloat(String, String, Single)

Declaration

[VisualScriptingMiscData("Entity Storage", "Stores float in the entity storage. This value is accessible from all scripts.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StoreEntityFloat(string entityName, string key, float value)

Parameters

Type	Name	Description
System.String	entityName
System.String	key
System.Single	value

StoreEntityFloatList(String, String, List<Single>)

Declaration

[VisualScriptingMiscData("Entity Storage", "Stores float list in the entity storage. This value is accessible from all scripts.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StoreEntityFloatList(string entityName, string key, List<float> value)

Parameters

Type	Name	Description
System.String	entityName
System.String	key
System.Collections.Generic.List<System.Single>	value

StoreEntityInteger(String, String, Int32)

Declaration

[VisualScriptingMiscData("Entity Storage", "Stores integer in the entity storage. This value is accessible from all scripts.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StoreEntityInteger(string entityName, string key, int value)

Parameters

Type	Name	Description
System.String	entityName
System.String	key
System.Int32	value

StoreEntityIntegerList(String, String, List<Int32>)

Declaration

[VisualScriptingMiscData("Entity Storage", "Stores integer list in the entity storage. This value is accessible from all scripts.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StoreEntityIntegerList(string entityName, string key, List<int> value)

Parameters

Type	Name	Description
System.String	entityName
System.String	key
System.Collections.Generic.List<System.Int32>	value

StoreEntityLong(String, String, Int64)

Declaration

[VisualScriptingMiscData("Entity Storage", "Stores long integer in the entity storage. This value is accessible from all scripts.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StoreEntityLong(string entityName, string key, long value)

Parameters

Type	Name	Description
System.String	entityName
System.String	key
System.Int64	value

StoreEntityLongList(String, String, List<Int64>)

Declaration

[VisualScriptingMiscData("Entity Storage", "Stores long list in the entity storage. This value is accessible from all scripts.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StoreEntityLongList(string entityName, string key, List<long> value)

Parameters

Type	Name	Description
System.String	entityName
System.String	key
System.Collections.Generic.List<System.Int64>	value

StoreEntityString(String, String, String)

Declaration

[VisualScriptingMiscData("Entity Storage", "Stores string in the entity storage. This value is accessible from all scripts.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StoreEntityString(string entityName, string key, string value)

Parameters

Type	Name	Description
System.String	entityName
System.String	key
System.String	value

StoreEntityStringList(String, String, List<String>)

Declaration

[VisualScriptingMiscData("Entity Storage", "Stores list of string in the entity storage. This value is accessible from all scripts.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StoreEntityStringList(string entityName, string key, List<string> value)

Parameters

Type	Name	Description
System.String	entityName
System.String	key
System.Collections.Generic.List<System.String>	value

StoreEntityVector(String, String, Vector3D)

Declaration

[VisualScriptingMiscData("Entity Storage", "Stores Vector3D (doubles) in the entity storage. This value is accessible from all scripts.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StoreEntityVector(string entityName, string key, Vector3D value)

Parameters

Type	Name	Description
System.String	entityName
System.String	key
Vector3D	value

StoreEntityVectorList(String, String, List<Vector3D>)

Declaration

[VisualScriptingMiscData("Entity Storage", "Stores Vector3D list in the entity storage. This value is accessible from all scripts.", -10510688)]
[VisualScriptingMember(true, false)]
public static void StoreEntityVectorList(string entityName, string key, List<Vector3D> value)

Parameters

Type	Name	Description
System.String	entityName
System.String	key
System.Collections.Generic.List<Vector3D>	value

SunRotationEnabled(Boolean)

Declaration

[VisualScriptingMiscData("Environment", "Enables/disable sun rotation.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SunRotationEnabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled

SunRotationGetCurrentTime()

Declaration

[VisualScriptingMiscData("Environment", "Gets current time of day.", -10510688)]
[VisualScriptingMember(false, false)]
public static float SunRotationGetCurrentTime()

Returns

Type	Description
System.Single

SunRotationGetDayLength()

Declaration

[VisualScriptingMiscData("Environment", "Gets length of day.", -10510688)]
[VisualScriptingMember(false, false)]
public static float SunRotationGetDayLength()

Returns

Type	Description
System.Single

SunRotationSetDayLength(Single)

Declaration

[VisualScriptingMiscData("Environment", "Sets length of day.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SunRotationSetDayLength(float length)

Parameters

Type	Name	Description
System.Single	length

SunRotationSetTime(Single)

Declaration

[VisualScriptingMiscData("Environment", "Sets time of day.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SunRotationSetTime(float time)

Parameters

Type	Name	Description
System.Single	time

SwitchToolbarToSlot(Int32, Int64)

Declaration

[VisualScriptingMiscData("Toolbar", "Switches the specified toolbar slot for the player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void SwitchToolbarToSlot(int slot, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	slot
System.Int64	playerId

SwitchToolbarToSlotLocal(Int32, Int64)

Declaration

public static void SwitchToolbarToSlotLocal(int slot, long playerId = -1L)

Parameters

Type	Name	Description
System.Int32	slot
System.Int64	playerId

TakeScreenshot(String, String)

Declaration

[VisualScriptingMiscData("Misc", "Takes a screenshot and saves it to specific destination.", -10510688)]
[VisualScriptingMember(true, false)]
public static void TakeScreenshot(string destination, string name)

Parameters

Type	Name	Description
System.String	destination
System.String	name

TargetingSetWhitelist(String, Boolean)

Declaration

[VisualScriptingMiscData("AI", "Sets whitelist targeting mode. If true, entities in whitelist will be considered a target, if false, entities not in whitelist will be considered a target.", -10510688)]
[VisualScriptingMember(true, false)]
public static void TargetingSetWhitelist(string gridName, bool whitelistMode = true)

Parameters

Type	Name	Description
System.String	gridName
System.Boolean	whitelistMode

ToggleAbilityToSprint(Int64, Boolean)

Declaration

[VisualScriptingMiscData("Player", "Toggles the players ability to sprint", -10510688)]
[VisualScriptingMember(true, false)]
public static void ToggleAbilityToSprint(long playerId = 0L, bool canSprint = true)

Parameters

Type	Name	Description
System.Int64	playerId
System.Boolean	canSprint

ToggleAbilityToSprintSync(Int64, Boolean)

Declaration

[Event(null, 7126)]
[Reliable]
[ServerInvoked]
[Broadcast]
public static void ToggleAbilityToSprintSync(long playerId = 0L, bool canSprint = true)

Parameters

Type	Name	Description
System.Int64	playerId
System.Boolean	canSprint

TogglePlayersBroadcastEnabling(Int64, Boolean)

Declaration

[VisualScriptingMiscData("Player", "Toggle player's ability to toggle broadcasting. Server still can change player's broadcasting state.", -10510688)]
[VisualScriptingMember(true, false)]
public static void TogglePlayersBroadcastEnabling(long playerId = 0L, bool enabled = true)

Parameters

Type	Name	Description
System.Int64	playerId
System.Boolean	enabled

TogglePlayersBroadcasting(Int64, Boolean)

Declaration

[VisualScriptingMiscData("Player", "Toggle broadcasting for the player.", -10510688)]
[VisualScriptingMember(true, false)]
public static void TogglePlayersBroadcasting(long playerId = 0L, bool enabled = true)

Parameters

Type	Name	Description
System.Int64	playerId
System.Boolean	enabled

ToolbarConfigGroupsDefualtBehavior()

Declaration

[VisualScriptingMiscData("G-Screen", "Sets group mode of toolbar config screen (G-screen) to Default.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ToolbarConfigGroupsDefualtBehavior()

ToolbarConfigGroupsHideAll()

Declaration

[VisualScriptingMiscData("G-Screen", "Sets group mode of toolbar config screen (G-screen) to Hide all.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ToolbarConfigGroupsHideAll()

ToolbarConfigGroupsHideBlockGroups()

Declaration

[VisualScriptingMiscData("G-Screen", "Sets group mode of toolbar config screen (G-screen) to Hide block groups.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ToolbarConfigGroupsHideBlockGroups()

ToolbarConfigGroupsHideEmpty()

Declaration

[VisualScriptingMiscData("G-Screen", "Sets group mode of toolbar config screen (G-screen) to Hide empty groups.", -10510688)]
[VisualScriptingMember(true, false)]
public static void ToolbarConfigGroupsHideEmpty()

TriggerTimerBlock(String)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Calls 'TriggerNow' action on specific functional block.", -10510688)]
[VisualScriptingMember(true, false)]
public static void TriggerTimerBlock(string blockName)

Parameters

Type	Name	Description
System.String	blockName

TriggerTimerBlockForNonFriendlyPlayer(String, Int64)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Calls 'TriggerNow' action on specific functional block If PlayerId belongs to not friendly player", -10510688)]
[VisualScriptingMember(true, false)]
public static void TriggerTimerBlockForNonFriendlyPlayer(string blockName, long playerId)

Parameters

Type	Name	Description
System.String	blockName
System.Int64	playerId

UnlockAchievementById(Int32, Int64)

Declaration

[VisualScriptingMiscData("Achievements", "Award player achievement. Id ID is -1, unlock to all, if ID is 0, unlock to local player, if anything else, it unlocks to player with that ID", -10510688)]
[VisualScriptingMember(true, false)]
public static void UnlockAchievementById(int achievementId, long playerId)

Parameters

Type	Name	Description
System.Int32	achievementId
System.Int64	playerId

WeaponSetShooting(String, Boolean)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Turns on/off shooting for specific weapon block (UserControllableGun)", -10510688)]
[VisualScriptingMember(true, false)]
public static void WeaponSetShooting(string weaponName, bool shooting = true)

Parameters

Type	Name	Description
System.String	weaponName
System.Boolean	shooting

WeaponShootOnce(String)

Declaration

[VisualScriptingMiscData("Blocks Specific", "Orders specific weapon block (UserControllableGun) to shoot once.", -10510688)]
[VisualScriptingMember(true, false)]
public static void WeaponShootOnce(string weaponName)

Parameters

Type	Name	Description
System.String	weaponName