Check game states. More...

#include "action_state.h"
#include "gctypes.h"
#include "logic.h"

Functions
bool	offstage (FunctionArg port)
	Checks if player (specified by `port`) is offstage. More...

bool	onstage (FunctionArg port)
	Checks if player (specified by `port`) is onstage. More...

bool	inHitstun (FunctionArg port)
	Checks if player (specified by `port`) is in hitstun. More...

bool	inHitlag (FunctionArg port)
	Checks if player (specified by `port`) is in hitlag. More...

bool	belowHeight (FunctionArg port, FunctionArg height)
	Checks if player (specified by `port`) is below `height`. More...

bool	aboveHeight (FunctionArg port, FunctionArg height)
	Checks if player (specified by `port`) is above `height`. More...

bool	inAir (FunctionArg port)
	Checks if player (specified by `port`) is in the air. More...

bool	onGround (FunctionArg port)
	Checks if player (specified by `port`) is in on the ground. More...

bool	actionStateEq (FunctionArg port, ActionState state)
	Checks the players (specified by `port`) action state. More...

bool	actionStateGeq (FunctionArg port, ActionState state)
	Checks the players (specified by `port`) action state. More...

bool	actionStateLeq (FunctionArg port, ActionState state)
	Checks the players (specified by `port`) action state. More...

bool	nearSurface (FunctionArg port)
	Checks if player (specified by `port`) is near a surface. More...

bool	techSituation (FunctionArg port)
	Checks if player (specified by `port`) needs to tech. More...

bool	hitlagFrames (FunctionArg port, FunctionArg frame)
	Checks if player (specified by `port`) has exact number of frames in hitlag remaining. More...

bool	hitstunFrames (FunctionArg port, FunctionArg frame)
	Checks if player (specified by `port`) has exact number of frames in hitstun remaining. More...

bool	recoverySituation (FunctionArg port)
	Checks if player (specified by `port`) needs to recover. More...

bool	fallenDown (FunctionArg port)
	Checks if player (specified by `port`) has fallen down. More...

bool	breakoutFrame (FunctionArg port, FunctionArg frames)
	Checks how frames until player (specified by `port`) breaks out of a grab. More...

bool	pastFrame (FunctionArg frame)
	Checks if a certain frame has passed. More...

Detailed Description

Check game states.

Function Documentation

bool offstage ( FunctionArg port )

Checks if player (specified by port) is offstage.

Parameters

port	- `unsigned 32-bit integer`

Returns: Returns true if the player at port is offstage

bool onstage ( FunctionArg port )

Checks if player (specified by port) is onstage.

Parameters

port	- `unsigned 32-bit integer`

Returns: Returns true if the player at port is onstage

bool inHitstun ( FunctionArg port )

Checks if player (specified by port) is in hitstun.

Parameters

port	- `unsigned 32-bit integer`

Returns: Returns true if player is in hitstun

bool inHitlag ( FunctionArg port )

Checks if player (specified by port) is in hitlag.

Parameters

port	- `unsigned 32-bit integer`

Returns: Returns true if player is in hitlag

bool belowHeight	(	FunctionArg	port,
		FunctionArg	height
	)

Checks if player (specified by port) is below height.

Parameters

port	- `unsigned 32-bit integer`
height	- `floating-point value`

Returns: Returns true if player is below height

bool aboveHeight	(	FunctionArg	port,
		FunctionArg	height
	)

Checks if player (specified by port) is above height.

Parameters

port	- `unsigned 32-bit integer`
height	- `floating-point value`

Returns: Returns true if player is above height

bool inAir ( FunctionArg port )

Checks if player (specified by port) is in the air.

Parameters

port	- `unsigned 32-bit integer`

Returns: Returns true if player is in in the air

bool onGround ( FunctionArg port )

Checks if player (specified by port) is in on the ground.

Parameters

port	- `unsigned 32-bit integer`

Returns: Returns true if player is on the ground

bool actionStateEq	(	FunctionArg	port,
		ActionState	state
	)

Checks the players (specified by port) action state.

Parameters

port	- `unsigned 32-bit integer`
state	- `unsigned 32-bit integer (ActionState)`

Returns: Returns true if player's action state equals state

bool actionStateGeq	(	FunctionArg	port,
		ActionState	state
	)

Checks the players (specified by port) action state.

Parameters

port	- `unsigned 32-bit integer`
state	- `unsigned 32-bit integer (ActionState)`

Returns: Returns true if player's action state greater than state

bool actionStateLeq	(	FunctionArg	port,
		ActionState	state
	)

Checks the players (specified by port) action state.

Parameters

port	- `unsigned 32-bit integer`
state	- `unsigned 32-bit integer (ActionState)`

Returns: Returns true if player's action state is less than state

bool nearSurface ( FunctionArg port )

Checks if player (specified by port) is near a surface.

Parameters

port	- `unsigned 32-bit integer`

Returns: Returns true if player is near a surface

bool techSituation ( FunctionArg port )

Checks if player (specified by port) needs to tech.

Parameters

port	- `unsigned 32-bit integer`

Returns: Returns true if player is in a tech situation

bool hitlagFrames	(	FunctionArg	port,
		FunctionArg	frame
	)

Checks if player (specified by port) has exact number of frames in hitlag remaining.

Parameters

port	- `unsigned 32-bit integer`
frame	- `unsigned 32-bit integer`

Returns: Returns true if player has frames of hitlag left

bool hitstunFrames	(	FunctionArg	port,
		FunctionArg	frame
	)

Checks if player (specified by port) has exact number of frames in hitstun remaining.

Parameters

port	- `unsigned 32-bit integer`
frame	- `unsigned 32-bit integer`

Returns: Returns true if player has frames of hitlag left

bool recoverySituation ( FunctionArg port )

Checks if player (specified by port) needs to recover.

Parameters

port	- `unsigned 32-bit integer`

Returns: Returns true if player needs to recover

bool fallenDown ( FunctionArg port )

Checks if player (specified by port) has fallen down.

Parameters

port	- `unsigned 32-bit integer`

Returns: Returns true if player has fallen down

bool breakoutFrame	(	FunctionArg	port,
		FunctionArg	frames
	)

Checks how frames until player (specified by port) breaks out of a grab.

Parameters

port	- `unsigned 32-bit integer`
frames	- `unsigned 32-bit integer`

Returns: Returns true if player has frames left until breakout

bool pastFrame ( FunctionArg frame )

Checks if a certain frame has passed.

Parameters

frame - unsigned 32-bit integer

Returns: Returns true if current frame is greater than frame

Functions

Detailed Description

Function Documentation