VRage.Game.ModAPI.IMyFactionCollection Interface Reference

Inheritance diagram for VRage.Game.ModAPI.IMyFactionCollection:

Public Member Functions
bool	FactionTagExists (string tag, IMyFaction doNotCheck=null)
bool	FactionNameExists (string name, IMyFaction doNotCheck=null)
IMyFaction	TryGetFactionById (long factionId)
IMyFaction	TryGetPlayerFaction (long playerId)
IMyFaction	TryGetFactionByTag (string tag)
IMyFaction	TryGetFactionByName (string name)
void	AddPlayerToFaction (long playerId, long factionId)
void	KickPlayerFromFaction (long playerId)
MyRelationsBetweenFactions	GetRelationBetweenFactions (long factionId1, long factionId2)
bool	AreFactionsEnemies (long factionId1, long factionId2)
bool	IsPeaceRequestStateSent (long myFactionId, long foreignFactionId)
bool	IsPeaceRequestStatePending (long myFactionId, long foreignFactionId)
void	RemoveFaction (long factionId)
void	SendPeaceRequest (long fromFactionId, long toFactionId)
void	CancelPeaceRequest (long fromFactionId, long toFactionId)
void	AcceptPeace (long fromFactionId, long toFactionId)
void	DeclareWar (long fromFactionId, long toFactionId)
void	SendJoinRequest (long factionId, long playerId)
void	CancelJoinRequest (long factionId, long playerId)
void	AcceptJoin (long factionId, long playerId)
void	KickMember (long factionId, long playerId)
void	PromoteMember (long factionId, long playerId)
void	DemoteMember (long factionId, long playerId)
void	MemberLeaves (long factionId, long playerId)
void	ChangeAutoAccept (long factionId, long playerId, bool autoAcceptMember, bool autoAcceptPeace)
void	EditFaction (long factionId, string tag, string name, string desc, string privateInfo)
void	CreateFaction (long founderId, string tag, string name, string desc, string privateInfo)
MyObjectBuilder_FactionCollection	GetObjectBuilder ()

Events
Action< long, bool, bool >	FactionAutoAcceptChanged
Action< long >	FactionEdited
Action< long >	FactionCreated

Detailed Description

Definition at line 9 of file IMyFactionCollection.cs.

Member Function Documentation

void VRage.Game.ModAPI.IMyFactionCollection.AcceptJoin	(	long	factionId,
		long	playerId
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

void VRage.Game.ModAPI.IMyFactionCollection.AcceptPeace	(	long	fromFactionId,
		long	toFactionId
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

void VRage.Game.ModAPI.IMyFactionCollection.AddPlayerToFaction	(	long	playerId,
		long	factionId
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

bool VRage.Game.ModAPI.IMyFactionCollection.AreFactionsEnemies	(	long	factionId1,
		long	factionId2
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

void VRage.Game.ModAPI.IMyFactionCollection.CancelJoinRequest	(	long	factionId,
		long	playerId
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

void VRage.Game.ModAPI.IMyFactionCollection.CancelPeaceRequest	(	long	fromFactionId,
		long	toFactionId
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

void VRage.Game.ModAPI.IMyFactionCollection.ChangeAutoAccept	(	long	factionId,
		long	playerId,
		bool	autoAcceptMember,
		bool	autoAcceptPeace
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

void VRage.Game.ModAPI.IMyFactionCollection.CreateFaction	(	long	founderId,
		string	tag,
		string	name,
		string	desc,
		string	privateInfo
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

void VRage.Game.ModAPI.IMyFactionCollection.DeclareWar	(	long	fromFactionId,
		long	toFactionId
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

void VRage.Game.ModAPI.IMyFactionCollection.DemoteMember	(	long	factionId,
		long	playerId
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

void VRage.Game.ModAPI.IMyFactionCollection.EditFaction	(	long	factionId,
		string	tag,
		string	name,
		string	desc,
		string	privateInfo
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

bool VRage.Game.ModAPI.IMyFactionCollection.FactionNameExists	(	string	name,
		IMyFaction	doNotCheck = null
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

bool VRage.Game.ModAPI.IMyFactionCollection.FactionTagExists	(	string	tag,
		IMyFaction	doNotCheck = null
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

MyObjectBuilder_FactionCollection VRage.Game.ModAPI.IMyFactionCollection.GetObjectBuilder

(

)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

MyRelationsBetweenFactions VRage.Game.ModAPI.IMyFactionCollection.GetRelationBetweenFactions	(	long	factionId1,
		long	factionId2
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

bool VRage.Game.ModAPI.IMyFactionCollection.IsPeaceRequestStatePending	(	long	myFactionId,
		long	foreignFactionId
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

bool VRage.Game.ModAPI.IMyFactionCollection.IsPeaceRequestStateSent	(	long	myFactionId,
		long	foreignFactionId
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

void VRage.Game.ModAPI.IMyFactionCollection.KickMember	(	long	factionId,
		long	playerId
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

void VRage.Game.ModAPI.IMyFactionCollection.KickPlayerFromFaction

(

long

playerId

)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

void VRage.Game.ModAPI.IMyFactionCollection.MemberLeaves	(	long	factionId,
		long	playerId
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

void VRage.Game.ModAPI.IMyFactionCollection.PromoteMember	(	long	factionId,
		long	playerId
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

void VRage.Game.ModAPI.IMyFactionCollection.RemoveFaction

(

long

factionId

)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

void VRage.Game.ModAPI.IMyFactionCollection.SendJoinRequest	(	long	factionId,
		long	playerId
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

void VRage.Game.ModAPI.IMyFactionCollection.SendPeaceRequest	(	long	fromFactionId,
		long	toFactionId
	)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

IMyFaction VRage.Game.ModAPI.IMyFactionCollection.TryGetFactionById

(

long

factionId

)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

IMyFaction VRage.Game.ModAPI.IMyFactionCollection.TryGetFactionByName

(

string

name

)

IMyFaction VRage.Game.ModAPI.IMyFactionCollection.TryGetFactionByTag

(

string

tag

)

IMyFaction VRage.Game.ModAPI.IMyFactionCollection.TryGetPlayerFaction

(

long

playerId

)

Implemented in Sandbox.Game.Multiplayer.MyFactionCollection.

Event Documentation

Action<long, bool, bool> VRage.Game.ModAPI.IMyFactionCollection.FactionAutoAcceptChanged

Definition at line 52 of file IMyFactionCollection.cs.

Action<long> VRage.Game.ModAPI.IMyFactionCollection.FactionCreated

Definition at line 62 of file IMyFactionCollection.cs.

Action<long> VRage.Game.ModAPI.IMyFactionCollection.FactionEdited

Definition at line 56 of file IMyFactionCollection.cs.

---

The documentation for this interface was generated from the following file:

• Sources/VRage.Game/ModAPI/IMyFactionCollection.cs