Player Data Structures

Functions

defaultMapGetPlayer()

defaultMapGetPlayer<V, Args>(map, player, …extraArgs): V

Defined in: packages/isaacscript-common/src/functions/playerDataStructures.ts:25

Helper function to make using default maps with an index of PlayerIndex easier. Use this instead of the DefaultMap.getAndSetDefault method if you have a default map of this type.

For example:

const v = {
  run: {
    playersSpeedBoost: new DefaultMap<PlayerIndex, int>(0),
  },
};

function evaluateCacheSpeed(player: EntityPlayer) {
  player.MoveSpeed = defaultMapGetPlayer(v.run.playersSpeedBoost, player);
}

Type Parameters

V

V

Args

Args extends unknown[]

Parameters

map

DefaultMap<PlayerIndex, V, Args>

player

EntityPlayer

extraArgs

…Args

Returns

V

Allow Empty Variadic

---

defaultMapSetPlayer()

defaultMapSetPlayer<V>(map, player, value): void

Defined in: packages/isaacscript-common/src/functions/playerDataStructures.ts:41

Helper function to make using maps with an index of PlayerIndex easier. Use this instead of the Map.set method if you have a map of this type.

Since Map and DefaultMap set values in the same way, this function is simply an alias for the mapSetPlayer helper function.

Type Parameters

V

V

Parameters

map

Map<PlayerIndex, V>

player

EntityPlayer

value

V

Returns

void

---

mapDeletePlayer()

mapDeletePlayer(map, player): boolean

Defined in: packages/isaacscript-common/src/functions/playerDataStructures.ts:54

Helper function to make using maps with an type of PlayerIndex easier. Use this instead of the Map.delete method if you have a set of this type.

Parameters

map

Map<PlayerIndex, unknown>

player

EntityPlayer

Returns

boolean

---

mapGetPlayer()

mapGetPlayer<V>(map, player): V | undefined

Defined in: packages/isaacscript-common/src/functions/playerDataStructures.ts:83

Helper function to make using maps with an index of PlayerIndex easier. Use this instead of the Map.get method if you have a map of this type.

For example:

const v = {
  run: {
    playersSpeedBoost: new Map<PlayerIndex, int>(),
  },
};

function incrementSpeedBoost(player: EntityPlayer) {
  const oldSpeedBoost = mapGetPlayer(v.run.playersSpeedBoost, player);
  const newSpeedBoost = oldSpeedBoost + 0.1;
  mapSetPlayer(v.run.playersSpeedBoost, player);
}

Type Parameters

V

V

Parameters

map

ReadonlyMap<PlayerIndex, V>

player

EntityPlayer

Returns

V | undefined

---

mapHasPlayer()

mapHasPlayer<V>(map, player): boolean

Defined in: packages/isaacscript-common/src/functions/playerDataStructures.ts:95

Helper function to make using maps with an index of PlayerIndex easier. Use this instead of the Map.has method if you have a map of this type.

Type Parameters

V

V

Parameters

map

ReadonlyMap<PlayerIndex, V>

player

EntityPlayer

Returns

boolean

---

mapSetPlayer()

mapSetPlayer<V>(map, player, value): void

Defined in: packages/isaacscript-common/src/functions/playerDataStructures.ts:123

Helper function to make using maps with an index of PlayerIndex easier. Use this instead of the Map.set method if you have a map of this type.

For example:

const v = {
  run: {
    playersSpeedBoost: new Map<PlayerIndex, int>(),
  },
};

function incrementSpeedBoost(player: EntityPlayer) {
  const oldSpeedBoost = mapGetPlayer(v.run.playersSpeedBoost, player);
  const newSpeedBoost = oldSpeedBoost + 0.1;
  mapSetPlayer(v.run.playersSpeedBoost, player);
}

Type Parameters

V

V

Parameters

map

Map<PlayerIndex, V>

player

EntityPlayer

value

V

Returns

void

---

setAddPlayer()

setAddPlayer(set, player): void

Defined in: packages/isaacscript-common/src/functions/playerDataStructures.ts:137

Helper function to make using sets with an type of PlayerIndex easier. Use this instead of the Set.add method if you have a set of this type.

Parameters

set

Set<PlayerIndex>

player

EntityPlayer

Returns

void

---

setDeletePlayer()

setDeletePlayer(set, player): boolean

Defined in: packages/isaacscript-common/src/functions/playerDataStructures.ts:150

Helper function to make using sets with an type of PlayerIndex easier. Use this instead of the Set.delete method if you have a set of this type.

Parameters

set

Set<PlayerIndex>

player

EntityPlayer

Returns

boolean

---

setHasPlayer()

setHasPlayer(set, player): boolean

Defined in: packages/isaacscript-common/src/functions/playerDataStructures.ts:163

Helper function to make using sets with an type of PlayerIndex easier. Use this instead of the Set.has method if you have a set of this type.

Parameters

set

ReadonlySet<PlayerIndex>

player

EntityPlayer

Returns

boolean