MatchBaseProps

What every <Match> takes.

Extends

• PropsWithChildren

Properties

Property	Type	Default value	Description
canJoin?	(world, player, match) => boolean	undefined	The game’s rule for whether player may take a slot, asked as the player’s block is seated: a refused block waits for another match.
countdownSeconds?	number	0	Seconds counted down before it plays.
delayedStart?	boolean	false	Waits in Waiting for startMatch or useMatch().start(), rather than starting as it mounts, or, in a room, as the first page opens its scene. A queue-less match’s alone. As Unreal’s bDelayedStart.
laps?	number	none: laps do not win it	The laps that win it, each a forward crossing of a trigger that holds a <LapLine>.
maxScore?	number	none: a lead of winBy alone wins	The score that wins it whatever winBy asks, as volleyball caps a win-by-two set at 15; the cap ends a match before its clock.
name?	string	"Match"	What a directory and a sign show.
overtimeSeconds?	number	0	Seconds of overtime a tie at time plays, in which the first lead wins, as Rocket League’s overtime; Infinity plays until one leads. With none a tie at time is a draw.
scoreCoins?	boolean	true	Whether coins addCoins credits score: each member’s own, or a co-op match’s shared score. Off for a game that scores with addMatchScore alone, so a purchase never scores a point.
scoreToWin?	number	none: a score does not win it	The score that wins it: coins addCoins credits while it plays, where scoreCoins is on, and what addMatchScore adds.
timeLimitSeconds?	number	no limit	Simulated seconds the players have.
whileEliminated?	"none" | "everyone" | "own-team" | MatchFollow	MatchFollow.OwnTeam	Whom a member watches while the member is eliminated, by a character downed with no respawn coming or by setMatchEliminated. Watches the member’s side’s members, as Fortnite’s eliminated players watch their squad, any member, or none, which keeps the member’s own character.
winBy?	number	1	The lead over every other competitor a win needs, as volleyball’s win by two.