Class IPlayer
Base player that stores all the information necessary to identify objects and areas belonging to the player. It also allows sending and receiving messages from the host. It will be used in a package featuring multiplayer to be released in version 1.2.
Namespace: AutoBattleFramework.Multiplayer.BattleBehaviour.Player
Assembly: cs.temp.dll.dll
Syntax
public abstract class IPlayer : NetworkBehaviourFields
CharacterBench
P^ayer Character bench.
Declaration
public Bench CharacterBenchField Value
| Type | Description |
|---|---|
| Bench |
instance
Static reference to the player.
Declaration
public static IPlayer instanceField Value
| Type | Description |
|---|---|
| IPlayer |
ItemBench
Player item bench.
Declaration
public Bench ItemBenchField Value
| Type | Description |
|---|---|
| Bench |
TraitList
Trait List UI of the player.
Declaration
public TraitListUI TraitListField Value
| Type | Description |
|---|---|
| TraitListUI |
TraitsToCheckTeam
Trat list of the player.
Declaration
public List<Trait> TraitsToCheckTeamField Value
| Type | Description |
|---|---|
| List<Trait> |
Properties
IsPlayerHost
If the player is the host.
Declaration
public bool IsPlayerHost { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
FusionMembers(List<GameCharacter>, ShopCharacter)
The host makes a fusion of characters.
Declaration
public abstract void FusionMembers(List<GameCharacter> fusionMembers, ShopCharacter FusionResult)Parameters
| Type | Name | Description |
|---|---|---|
| List<GameCharacter> | fusionMembers | List of fusion members. |
| ShopCharacter | FusionResult | Result of the fusion |
GetPlayerById(UInt64)
Get the player instance by its ID.
Declaration
public static IPlayer GetPlayerById(ulong ID)Parameters
| Type | Name | Description |
|---|---|---|
| UInt64 | ID | ID of the player. |
Returns
| Type | Description |
|---|---|
| IPlayer | Player instance with the given ID. |
NextStage()
Make the player change the stage.
Declaration
public abstract void NextStage()RemoveItemFromCharacterClient(UInt64, UInt16)
The host removes the item from a character.
Declaration
public abstract void RemoveItemFromCharacterClient(ulong GameCharacterID, ushort itemModificatorIndex)Parameters
| Type | Name | Description |
|---|---|---|
| UInt64 | GameCharacterID | Character's network ID. |
| UInt16 | itemModificatorIndex | Index of the item modificator. |
RemoveItemFromCharacterServer(UInt64, UInt16)
ASk the server to remove the item from a character.
Declaration
public abstract void RemoveItemFromCharacterServer(ulong GameCharacterID, ushort itemModificatorIndex)Parameters
| Type | Name | Description |
|---|---|---|
| UInt64 | GameCharacterID | Character's network ID. |
| UInt16 | itemModificatorIndex | Index of the item modificator. |
ResetCharactersPositionsClient()
The host moves the character to the starting position.
Declaration
public abstract void ResetCharactersPositionsClient()SpawnGameActorServer(Unity.Collections.FixedString128Bytes, Single, Single, Single)
Ask the host to spawn a GameActor at the given position.
Declaration
public abstract void SpawnGameActorServer(Unity.Collections.FixedString128Bytes itemName, float x, float y, float z)Parameters
| Type | Name | Description |
|---|---|---|
| Unity.Collections.FixedString128Bytes | itemName | Actor�s item name |
| Single | x | X position |
| Single | y | Y position |
| Single | z | Z position |