view libmlk-rpg/mlk/rpg/selection.h @ 567:90302d95cd33

core: doxygenize util
author David Demelier <markand@malikania.fr>
date Wed, 08 Mar 2023 21:13:07 +0100
parents 6e8f6640e05b
children
line wrap: on
line source

/*
 * selection.h -- kind of selection
 *
 * 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.
 */

#ifndef MLK_RPG_SELECTION_H
#define MLK_RPG_SELECTION_H

#include <mlk/core/core.h>

struct battle;

enum selection_kind {
	SELECTION_KIND_SELF,
	SELECTION_KIND_ONE,
	SELECTION_KIND_ALL,
	SELECTION_KIND_BOTH
};

enum selection_side {
	/* Which side allowed (can be both). */
	SELECTION_SIDE_TEAM     = (1 << 0),
	SELECTION_SIDE_ENEMY    = (1 << 1)
};

struct selection {
	enum selection_kind allowed_kinds;
	enum selection_side allowed_sides;

	/* Character index in battle entity array. */
	unsigned int index_character;

	/* Side index (0 = enemy, 1 = team). */
	unsigned int index_side;
};

#if defined(__cplusplus)
extern "C" {
#endif

void
selection_first(struct selection *, const struct battle *);

void
selection_random(struct selection *, const struct battle *);

MLK_CORE_END_DECLS

#endif /* !MLK_RPG_SELECTION_H */