Inheritance diagram for Sandbox.Game.World.MyFaction:

Public Member Functions
	MyFaction (long id, string tag, string name, string desc, string privateInfo, long creatorId)

	MyFaction (MyObjectBuilder_Faction obj)

bool	IsFounder (long playerId)

bool	IsLeader (long playerId)

bool	IsMember (long playerId)

bool	IsNeutral (long playerId)

bool	IsEveryoneNpc ()

void	AddJoinRequest (long playerId)

void	CancelJoinRequest (long playerId)

void	AcceptJoin (long playerId, bool autoaccept=false)

void	KickMember (long playerId)

void	PromoteMember (long playerId)

void	DemoteMember (long playerId)

void	PromoteToFounder (long playerId)

void	CheckAndFixFactionRanks ()

MyObjectBuilder_Faction	GetObjectBuilder ()

Public Attributes
string	Tag

string	Name

string	Description

string	PrivateInfo

bool	AutoAcceptMember

bool	AutoAcceptPeace

bool	AcceptHumans

bool	EnableFriendlyFire = true

Properties
long	FactionId `[get]`

long	FounderId `[get]`

DictionaryReader< long, MyFactionMember >	Members `[get]`

DictionaryReader< long, MyFactionMember >	JoinRequests `[get]`

Properties inherited from VRage.Game.ModAPI.IMyFaction
long	FactionId `[get]`

string	Tag `[get]`

string	Name `[get]`

string	Description `[get]`

string	PrivateInfo `[get]`

bool	AutoAcceptMember `[get]`

bool	AutoAcceptPeace `[get]`

bool	AcceptHumans `[get]`

long	FounderId `[get]`

VRage.Collections.DictionaryReader< long, MyFactionMember >	Members `[get]`

VRage.Collections.DictionaryReader< long, MyFactionMember >	JoinRequests `[get]`

Detailed Description

Definition at line 20 of file MyFaction.cs.

Constructor & Destructor Documentation

Sandbox.Game.World.MyFaction.MyFaction	(	long	id,
		string	tag,
		string	name,
		string	desc,
		string	privateInfo,
		long	creatorId
	)

inline

Definition at line 41 of file MyFaction.cs.

Sandbox.Game.World.MyFaction.MyFaction ( MyObjectBuilder_Faction obj )

inline

Definition at line 60 of file MyFaction.cs.

Member Function Documentation

void Sandbox.Game.World.MyFaction.AcceptJoin	(	long	playerId,
		bool	autoaccept = `false`
	)

inline

Definition at line 167 of file MyFaction.cs.

void Sandbox.Game.World.MyFaction.AddJoinRequest ( long playerId )

inline

Definition at line 157 of file MyFaction.cs.

void Sandbox.Game.World.MyFaction.CancelJoinRequest ( long playerId )

inline

Definition at line 162 of file MyFaction.cs.

void Sandbox.Game.World.MyFaction.CheckAndFixFactionRanks ( )

inline

Definition at line 219 of file MyFaction.cs.

void Sandbox.Game.World.MyFaction.DemoteMember ( long playerId )

inline

Definition at line 197 of file MyFaction.cs.

MyObjectBuilder_Faction Sandbox.Game.World.MyFaction.GetObjectBuilder ( )

inline

Definition at line 247 of file MyFaction.cs.

bool Sandbox.Game.World.MyFaction.IsEveryoneNpc ( )

inline

Implements VRage.Game.ModAPI.IMyFaction.

Definition at line 144 of file MyFaction.cs.

bool Sandbox.Game.World.MyFaction.IsFounder ( long playerId )

inline

Implements VRage.Game.ModAPI.IMyFaction.

Definition at line 108 of file MyFaction.cs.

bool Sandbox.Game.World.MyFaction.IsLeader ( long playerId )

inline

Implements VRage.Game.ModAPI.IMyFaction.

Definition at line 118 of file MyFaction.cs.

bool Sandbox.Game.World.MyFaction.IsMember ( long playerId )

inline

Implements VRage.Game.ModAPI.IMyFaction.

Definition at line 128 of file MyFaction.cs.

bool Sandbox.Game.World.MyFaction.IsNeutral ( long playerId )

inline

Implements VRage.Game.ModAPI.IMyFaction.

Definition at line 134 of file MyFaction.cs.

void Sandbox.Game.World.MyFaction.KickMember ( long playerId )

inline

Definition at line 180 of file MyFaction.cs.

void Sandbox.Game.World.MyFaction.PromoteMember ( long playerId )

inline

Definition at line 187 of file MyFaction.cs.

void Sandbox.Game.World.MyFaction.PromoteToFounder ( long playerId )

inline

Definition at line 207 of file MyFaction.cs.

Member Data Documentation

bool Sandbox.Game.World.MyFaction.AcceptHumans

Definition at line 35 of file MyFaction.cs.

bool Sandbox.Game.World.MyFaction.AutoAcceptMember

Definition at line 33 of file MyFaction.cs.

bool Sandbox.Game.World.MyFaction.AutoAcceptPeace

Definition at line 34 of file MyFaction.cs.

string Sandbox.Game.World.MyFaction.Description

Definition at line 28 of file MyFaction.cs.

bool Sandbox.Game.World.MyFaction.EnableFriendlyFire = true

Definition at line 36 of file MyFaction.cs.

string Sandbox.Game.World.MyFaction.Name

Definition at line 27 of file MyFaction.cs.

string Sandbox.Game.World.MyFaction.PrivateInfo

Definition at line 29 of file MyFaction.cs.

string Sandbox.Game.World.MyFaction.Tag

Definition at line 26 of file MyFaction.cs.

Property Documentation

long Sandbox.Game.World.MyFaction.FactionId

get

Definition at line 25 of file MyFaction.cs.

long Sandbox.Game.World.MyFaction.FounderId

get

Definition at line 31 of file MyFaction.cs.

DictionaryReader<long, MyFactionMember> Sandbox.Game.World.MyFaction.JoinRequests

get

Definition at line 39 of file MyFaction.cs.

DictionaryReader<long, MyFactionMember> Sandbox.Game.World.MyFaction.Members

get

Definition at line 38 of file MyFaction.cs.

The documentation for this class was generated from the following files:

Sources/Sandbox.Game/Game/World/MyFaction.cs
Sources/Sandbox.Game/ModAPI/MyFaction_ModAPI.cs

Public Member Functions

Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation