ss.powerplays

Power Plays are the traps of a level: the fuel trucks, the parked cars and coaches, the helicopters, and the big ones that change the route. ss.powerplays lists every Power Play the loaded level has, whether a player could reach it right now or not, and a script can set one off, reset it or switch it off. A Power Play is a live object: reading a field reads the game at that moment. Power Plays only exist within a race.

Static members#

These elements are static to the class itself and can be accessed like so:

local ahead = ss.powerplays.near(ss.vehicle.position, 150)

Static functions#

Instance members#

Instance members must be accessed through a reference to a specific Power Play object.

local truck = ss.powerplays.find("fueltruck")[1]
if truck.ready then truck:fire(ss.player) end

Instance Methods#

What is a method?

Instance Fields#

Instance Memory Offsets#

These offsets can be manipulated by the instance's mem method. They are relative to address.

Firing a Power Play#

fire hands the Power Play to the game the same way a player's button does, so everything that follows is the game's own: the explosion, the wrecks, the debris. The Power Play goes off two frames later, and that is when the powerplay event runs, with scripted set to true.

A fire from a script is free. It does not look at anybody's power bar and does not spend it, and the Power Play's level does not matter. Nobody has to be near it either.

Some of the big Power Plays can be fired a second time a while after the first, as they can by a player. ready reads true again when that second fire is possible, even though state still reads playing.

When the game cannot accept the fire, fire returns false and one of these reasons:

-- Fires every Power Play near the leader as the local player's, once every five seconds.
ss.on("race_start", function()
	ss.every(5, function()
		local leader
		for car in ss.vehicles.each() do
			if not leader or car.race.position < leader.race.position then leader = car end
		end
		if not leader or leader.is_local then return end
		for _, pp in ipairs(ss.powerplays.near(leader.position + leader.forward * 40, 120)) do
			if pp.ready then pp:fire(ss.player) end
		end
	end)
end)

Using a Power Play again#

Most Power Plays go off once and then stay played. reset rebuilds one through the game's own reset. Wait until ready reads true before firing it again.

-- Blows up the same row of parked cars every eight seconds.
local cars = ss.powerplays.find("^Cars_5$")[1]
ss.every(8, function()
	if not cars.valid then return end
	if cars.ready then
		cars:fire()
	elseif cars.state == "played" then
		cars:reset()
	end
end)

Switching a Power Play off#

Setting enabled to false takes a Power Play out of the race for everybody. It is in nobody's reach, the AI's included, and fire returns false. Setting it back to true brings it back.

-- The airport without its two route changes.
ss.on("race_start", function()
	for _, pp in ipairs(ss.powerplays.find("^RCA")) do pp.enabled = false end
end)