🪖 Arma Reforger

• Hints
• Console Output
  • Print()
  • PrintFormat()
• Check Locality ...
  • ... for an Entity that has a RplComponent
  • ... more in general
• Find entities
• Spectator
• Teleport
• Scheduled execution
• Check for Workbench Mode
• Check if Game Master is controlling an entity (possessing)
• Accessing Map Markers
• Get Terrain Level on Position
• Attaching Stuff to other Stuff

Hints

string title = "Gruppe Adler"; // default = string.Empty
string message = "rulez";
float duration = 10.0; // in seconds
bool isSilent = false; // default = false

SCR_HintManagerComponent.GetInstance().ShowCustomHint(message, title, duration, isSilent);

SCR_HintManagerComponent.GetInstance().ShowCustomHint(message);

Console Output

Print()

// LogLevel defaults to LogLevel.NORMAL

Print("spam message", LogLevel.SPAM);
Print("verbose message", LogLevel.VERBOSE);
Print("debug message", LogLevel.DEBUG);
Print("normal message", LogLevel.NORMAL);
Print("warning message", LogLevel.WARNING);
Print("error message", LogLevel.ERROR);
Print("fatal message", LogLevel.FATAL);

//Perhaps SPAM, VERBOSE and DEBUG only show up if special states are active, like Debug Mode

PrintFormat()

string s1 = "The";
string s2 = "quick";
string s3 = "brown";
string s4 = "fox";
string s5 = "jumps";
string s6 = "over";
string s7 = "a";
string s8 = "lazy";
string s9 = "dog";

PrintFormat("%1 %2 %3 %4 %5 %6 %7 %8 %9.", s1, s2, s3, s4, s5, s6, s7, s8, s9);

// PrintFormat() does not support LogLevel but you could use this instead:
Print(string.Format("%1 %2 %3 %4 %5 %6 %7 %8 %9.", s1, s2, s3, s4, s5, s6, s7, s8, s9), LogLevel.NORMAL);

// I think I read somewhere that the parameter count of functions is generally limited to 9 or 10

Check Locality ...

... for an Entity that has a RplComponent

IEntity entity = GetGame().GetWorld().FindEntityByName("MyEntity");

RplComponent rplComp = RplComponent.Cast(entity.FindComponent(RplComponent));

if (rplComp.Role() == RplRole.Authority)
{
	Print("This computer hat the role 'Authority' for this entity.");
}
if (rplComp.Role() == RplRole.Proxy)
{
	Print("This computer hat the role 'Proxy' for this entity.");
}

PrintFormat("Master: %1", rplComp.IsMaster());
PrintFormat("Owner: %1", rplComp.IsOwner());
PrintFormat("Proxy: %1", rplComp.IsProxy());

... more in general

PrintFormat("Server: %1", Replication.IsServer());
PrintFormat("Client: %1", Replication.IsClient());

Find entities

// Give your entity a name in in the object properties (It's something like a variable name)

IEntity entity = GetGame().GetWorld().FindEntityByName("MyEntity");

Spectator

See GRAD Spectator for implementation details: https://github.com/gruppe-adler/GRAD-Spectator

// Execute locally

// Get players entity position
vector pos = GetGame().GetPlayerController().GetControlledEntity().GetOrigin();

// Change position to be above and behind the entity
pos[2] = pos[2] - 4;
pos[1] = pos[1] + 3;
		
// Enable specator by spawning the spectator entity at the given position
EntitySpawnParams params = new EntitySpawnParams();
params.Transform[3] = pos;
Resource r = Resource.Load("{E1FF38EC8894C5F3}Prefabs/Editor/Camera/ManualCameraSpectate.et");
IEntity spectator = GetGame().SpawnEntityPrefab(r, GetGame().GetWorld(), params);

// Disable specator by deleting spectator entity
SCR_EntityHelper.DeleteEntityAndChildren(spectator);

Teleport

IEntity target = GetGame().GetWorld().FindEntityByName("SpawnPoint");

// This will not work very well in MP when executed on server
GetGame().GetPlayerController().GetControlledEntity().SetOrigin(target.GetOrigin());

// execute locally on players machine; works in MP
SCR_Global.TeleportLocalPlayer(target.GetOrigin(), SCR_EPlayerTeleportedReason.DEFAULT);

// alternative syntax
SCR_Global.TeleportPlayer(playerId, target.GetOrigin(), SCR_EPlayerTeleportedReason.DEFAULT);

Scheduled execution

int delay = 250; // milliseconds
bool repeat = false;
string parameter1 = "Hello ";
string parameter2 = "World!";

GetGame().GetCallqueue().CallLater(FunctionWithoutBraces, delay, repeat, parameter1, parameter2);

Check for Workbench Mode

SCR_Global.IsEditMode();
// returns true if currentlich in Workbench Mode and not in-game

Check if Game Master is controlling an entity (possessing)

// This is a given entity; This is dummy code
IEntity entity;

int playerId = GetGame().GetPlayerManager().GetPlayerIdFromControlledEntity(entity);
SCR_PlayerController playerController =  SCR_PlayerController.Cast(GetGame().GetPlayerManager().GetPlayerController(playerId));
if (!playerController)
	return;

// Possessing means that the game master is controlling an AI character
// The game master also has (optionally) it's own character; If he controls his own unit, it's not possessing
Print(string.Format("isPossessing: %1", playerController.IsPossessing()), LogLevel.NORMAL);

Accessing Map Markers

SCR_MapMarkerManagerComponent mapMarkerManagerComp = SCR_MapMarkerManagerComponent.GetInstance();

array<ref SCR_MapMarkerBase> staticMarkers = mapMarkerManagerComp.GetStaticMarkers();

foreach (SCR_MapMarkerBase staticMarker : staticMarkers)
{
	// other interesting types are PLACED_MILITARY or SQUAD_LEADER which is a dynamic marker
	if (staticMarker.GetType() == SCR_EMapMarkerType.PLACED_CUSTOM)
	{
		int markerPos[2];
		staticMarker.GetWorldPos(markerPos);
		string markerText = staticMarker.GetCustomText();
		Print(string.Format("Custom Marker '%1' is at pos %2", markerText, markerPos));
	}
}

Get Terrain Level on Position

// Arma3 eq: GetPosATL // GetPos

float wy = GetWorld().GetSurfaceY(x, z);

Attaching Stuff to other Stuff

// Arma3 eq: attachTo

//!Add Entity to hierarchy. Pivot is pivot index, or -1 for center of parent.
// The child has to have the hierarchy component. Only one requires hierarchy component.

proto external int AddChild(notnull IEntity child, TNodeId pivot, EAddChildFlags flags = EAddChildFlags.AUTO_TRANSFORM);

proto external void RemoveChild(notnull IEntity child, bool keepTransform = false);