# PlayerList

## 导入类

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.
```zenscript
import crafttweaker.api.server.PlayerList;
```


## 使用方式

:::group{name=getMaxPlayers}

Return Type: int

```zenscript
// PlayerList.getMaxPlayers() as int

myPlayerList.getMaxPlayers();
```

:::

:::group{name=getPlayer}

Return Type: [ServerPlayer](/vanilla/api/entity/type/player/ServerPlayer)?

```zenscript
PlayerList.getPlayer(uuid as invalid) as ServerPlayer?
```

| 参数   | 类型          |
| ---- | ----------- |
| uuid | **invalid** |


:::

:::group{name=getPlayerByName}

Return Type: [ServerPlayer](/vanilla/api/entity/type/player/ServerPlayer)?

```zenscript
PlayerList.getPlayerByName($$0 as string) as ServerPlayer?
```

| 参数  | 类型     |
| --- | ------ |
| $$0 | string |


:::

:::group{name=getPlayerCount}

Return Type: int

```zenscript
// PlayerList.getPlayerCount() as int

myPlayerList.getPlayerCount();
```

:::

:::group{name=getPlayers}

Return Type: stdlib.List&lt;[ServerPlayer](/vanilla/api/entity/type/player/ServerPlayer)&gt;

```zenscript
// PlayerList.getPlayers() as stdlib.List<ServerPlayer>

myPlayerList.getPlayers();
```

:::

:::group{name=getServer}

Return Type: [Server](/vanilla/api/game/Server)

```zenscript
// PlayerList.getServer() as Server

myPlayerList.getServer();
```

:::

:::group{name=getSimulationDistance}

Return Type: int

```zenscript
// PlayerList.getSimulationDistance() as int

myPlayerList.getSimulationDistance();
```

:::

:::group{name=getViewDistance}

Return Type: int

```zenscript
// PlayerList.getViewDistance() as int

myPlayerList.getViewDistance();
```

:::

:::group{name=isAllowCheatsForAllPlayers}

Return Type: boolean

```zenscript
// PlayerList.isAllowCheatsForAllPlayers() as boolean

myPlayerList.isAllowCheatsForAllPlayers();
```

:::


## 参数

| 名称                         | 类型                                                                                          | 可获得  | 可设置   |
| -------------------------- | ------------------------------------------------------------------------------------------- | ---- | ----- |
| isAllowCheatsForAllPlayers | 布尔值                                                                                         | true | false |
| maxPlayers                 | int                                                                                         | true | false |
| playerCount                | int                                                                                         | true | false |
| players                    | stdlib.List&lt;[ServerPlayer](/vanilla/api/entity/type/player/ServerPlayer)&gt; | true | false |
| server                     | [Server](/vanilla/api/game/Server)                                                          | true | false |
| simulationDistance         | int                                                                                         | true | false |
| viewDistance               | int                                                                                         | true | false |



名称	类型	可获得	可设置
名称 isAllowCheatsForAllPlayers	类型布尔值	可获得 true	可设置 false
名称 maxPlayers	类型 int	可获得 true	可设置 false
名称 playerCount	类型 int	可获得 true	可设置 false
名称 players	类型 stdlib.List<ServerPlayer>	可获得 true	可设置 false
名称 server	类型 Server	可获得 true	可设置 false
名称 simulationDistance	类型 int	可获得 true	可设置 false
名称 viewDistance	类型 int	可获得 true	可设置 false