VRage.Game.ModAPI
IMyFaction
Assembly: VRage.Game.dll
public interface IMyFaction
Describes faction (mods interface)
Properties
| Member | Description |
|---|---|
| AcceptHumans | Gets or set if faction accepts players |
| AutoAcceptMember | Gets if faction automatically accept new members |
| AutoAcceptPeace | Gets if faction automatically accept peace from other factions |
| CustomColor | Gets faction icon background color |
| Description | Gets faction description |
| FactionIcon | Gets faction icon |
| FactionId | Gets faction id |
| FactionType | Gets faction type: Pirate, Miner ... |
| FounderId | IdentityId of founder of faction |
| IconColor | Gets faction icon color |
| JoinRequests | Gets all faction join requests. |
| Members | Gets all members (founder, leaders also) of faction. |
| Name | Gets faction name |
| ObjectivePercentageCompleted | Gets or sets percentage of completed objective. Used in Uranium Heist scenario |
| PrivateInfo | Gets faction private info |
| Score | Gets or sets score of faction. Used in Uranium Heist scenario |
| Stations | Gets stations for the NPC (economy trading) faction |
| Tag | Gets faction tag |
Methods
| Member | Description |
|---|---|
| GetBalanceShortString() | Gets balance of an account associated with faction. Format is 'BALANCE CURRENCYSHORTNAME'. |
| GetStationById(long) | Gets station by id |
| HasLastMember() | Returns if faction has last member |
| IsEnemy(long) | Returns if player with provided playerId is enemy to faction |
| IsEveryoneNpc() | Returns if faction has no humans |
| IsFounder(long) | Returns if player with provided playerId is founder of faction |
| IsFriendly(long) | Returns if player with provided playerId is friendly to faction |
| IsLeader(long) | Returns if player with provided playerId is faction leader |
| IsMember(long) | Returns if player with provided playerId is faction member |
| IsNeutral(long) | Returns if player with provided playerId is neutral to faction |
| RequestChangeBalance(long) | Changes the balance of the account of this faction by given amount. Sends a message to server with the request. |
| TryGetBalanceInfo(out long) | Gets balance of an account associated with faction. |