com.mingweisamuel.zyra.entity

Class MatchEntity.ParticipantEntity

java.lang.Object

com.mingweisamuel.zyra.entity.Entity

com.mingweisamuel.zyra.entity.MatchEntity.ParticipantEntity

Enclosing class:

MatchEntity

public class MatchEntity.ParticipantEntity
extends Entity

A entity representation of a participantInfo in a single match. May or may not be associated with a SummonerEntity.

Field Summary

Fields inherited from class com.mingweisamuel.zyra.entity.Entity

entityApi, region

Method Summary

Modifier and Type	Method and Description
int	getParticipantId()
Participant	getParticipantInfo()
SummonerEntity	getSummonerEntity() Gets the summoner entity who played as this participantInfo. May return cached SummonerEntity instance as described in EntityApi.getSummonerFromPlayer(Player).
MatchEntity.TeamEntity	getTeam()
int	getTeamId()
SortedMap<Long,MatchParticipantFrame>	getTimeline()
CompletableFuture<SortedMap<Long,MatchParticipantFrame>>	getTimelineAsync()

Methods inherited from class com.mingweisamuel.zyra.entity.Entity

getRegion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getParticipantId

public int getParticipantId()

Returns:

The participant's unique encId for the match.

getSummonerEntity

public SummonerEntity getSummonerEntity()

Gets the summoner entity who played as this participantInfo.

May return cached SummonerEntity instance as described in EntityApi.getSummonerFromPlayer(Player).

Returns:

The summoner entity. May be null if summoner entity doesn't exist. This occurs when matches do not include identity information which usually means the match was unranked.

getParticipantInfo

public Participant getParticipantInfo()

Returns:

The participant information.

getTeamId

public int getTeamId()

Returns:

The participant's teamId. See TeamId.

getTeam

public MatchEntity.TeamEntity getTeam()

Returns:

The participant's TeamEntity.

getTimelineAsync

public CompletableFuture<SortedMap<Long,MatchParticipantFrame>> getTimelineAsync()

Returns:

A CompletableFuture for this participant's timeline, which is a map from timestamps (long) to MatchParticipantFrames. The map is sorted in chronological order (ascending timestamps).

getTimeline

public SortedMap<Long,MatchParticipantFrame> getTimeline()

Returns:

This participant's timeline, which is a map from timestamps (long) to MatchParticipantFrames. The map is sorted in chronological order (ascending timestamps).
May block while waiting for data.