view libmlk-core/mlk/core/action.c @ 509:a11cd7ea3a37

core: doxygenize action
author David Demelier <markand@malikania.fr>
date Sat, 04 Mar 2023 08:52:57 +0100
parents c1f64d451230
children
line wrap: on
line source

/*
 * action.c -- generic in game actions
 *
 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#include <assert.h>

#include "action.h"

void
mlk_action_start(struct mlk_action *act)
{
	assert(act);

	if (act->start)
		act->start(act);
}

void
mlk_action_handle(struct mlk_action *act, const union mlk_event *ev)
{
	assert(act);
	assert(ev);

	if (act->handle)
		act->handle(act, ev);
}

int
mlk_action_update(struct mlk_action *act, unsigned int ticks)
{
	assert(act);

	if (act->update)
		return act->update(act, ticks);

	/* No function means immortal action. */
	return 0;
}

void
mlk_action_draw(struct mlk_action *act)
{
	assert(act);

	if (act->draw)
		act->draw(act);
}

void
mlk_action_end(struct mlk_action *act)
{
	assert(act);

	if (act->end)
		act->end(act);
}

void
mlk_action_finish(struct mlk_action *act)
{
	assert(act);

	if (act->finish)
		act->finish(act);
}