minigames.qh File Reference

#include "minigame/all.qh"

Include dependency graph for minigames.qh:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
	int (entity, string,...) minigame_event
	For minigame sessions/descriptors: execute the given event Client events: mouse_moved(vector mouse_pos) return 1 to handle input, 0 to discard mouse_pressed/released(int K_Keycode) return 1 to handle input, 0 to discard note: see dpdefs/keycodes.qc for values key_pressed/released(int K_Keycode) return 1 to handle input, 0 to discard note: see dpdefs/keycodes.qc for values activate() executed when the minigame is activated for the current client deactivate() executed when the minigame is deactivated for the current client network_receive(entity received,int flags) executed each time a networked entity is received note: when this is called self == ...(0,entity) You can use the MINIG_SF_ constants to check the send flags IMPORTANT: always read in client everything you send from the server!
int	minigame_count_players (entity minigame)
entity	minigame_get_descriptor (string id)
entity	minigame_get_owner (int id)
int	minigame_next_team (int curr_team, int n_teams)
int	minigame_prev_team (int curr_team, int n_teams)
string	minigame_relative_tile (string start_id, int dx, int dy, int rows, int columns)
void	minigame_server_sendflags (entity ent, int mgflags)
string	minigame_tile_buildname (int letter, int number)
int	minigame_tile_letter (string id)
string	minigame_tile_name (vector pos, int rows, int columns)
int	minigame_tile_number (string id)
vector	minigame_tile_pos (string id, int rows, int columns)
string	msle_classname (int id)
int	msle_id (string class_name)
entity	msle_spawn (entity minigame_session, entity e)

Variables
entity	descriptor
	For minigame sessions: minigame descriptor object.
entity	list_next
entity	list_prev
const int	MINIG_SF_ALL = 0xff
const int	MINIG_SF_CREATE = 0x01
const int	MINIG_SF_CUSTOM = 0x10
const int	MINIG_SF_MAX = 0x80
const int	MINIG_SF_UPDATE = 0x02
bool	minigame_autoclean
int	minigame_flags
int	minigame_id
	Unique ID for the minigame session, associated with all objects currently the result of etof(minigame) on the server.

Function Documentation

int()

int	(	entity	,
		string	,
			... )

For minigame sessions/descriptors: execute the given event Client events: mouse_moved(vector mouse_pos) return 1 to handle input, 0 to discard mouse_pressed/released(int K_Keycode) return 1 to handle input, 0 to discard note: see dpdefs/keycodes.qc for values key_pressed/released(int K_Keycode) return 1 to handle input, 0 to discard note: see dpdefs/keycodes.qc for values activate() executed when the minigame is activated for the current client deactivate() executed when the minigame is deactivated for the current client network_receive(entity received,int flags) executed each time a networked entity is received note: when this is called self == ...(0,entity) You can use the MINIG_SF_ constants to check the send flags IMPORTANT: always read in client everything you send from the server!

menu_show(entity parent_menu_item) executed when the Current Game menu is shown, used to add custom entries Call HUD_MinigameMenu_CustomEntry to do so (pass ...(0,entity) as first argument) menu_click(string arg) executed when a custom menu entry is clicked Server events: start() executed when the minigame session is starting end() executed when the minigame session is shutting down join(entity player) executed when a player wants to join the session return the player team number to accept the new player, 0 to discard part(entity player) executed when a player is going to leave the session network_send(entity sent,int flags) executed each time a networked entity is sent note: when this is called self == ...(0,entity) You can use the MINIG_SF_ constants to check the send flags IMPORTANT: always read in client everything you send from the server! cmd(entity minigame_player, int argc, string command) self = client entity triggering this argv(n) = console token argc: number of console tokens command: full command string triggered when a player does "cmd minigame ..." with some unrecognized command return 1 if the minigame has handled the command impulse(entity minigame_player,int impulse) self = client entity triggering this triggered when a player does "impulse ..." return 1 if the minigame has handled the impulse

References entity().

minigame_count_players()

int minigame_count_players

(

entity

minigame

)

Definition at line 132 of file minigames.qc.

{
    int pl_num = 0;
    entity e;
#ifdef SVQC
    for(e = minigame.minigame_players; e; e = e.list_next)
#elif defined(CSQC)
    e = NULL;
    while( (e = findfloat(e,minigame_id,minigame.minigame_id)) )
        if ( e.classname == "minigame_player" )
#endif
        ++pl_num;
    return pl_num;
}

References entity(), findfloat(), minigame_id, and NULL.

Referenced by bd_server_event(), c4_server_event(), pp_server_event(), ps_server_event(), and ttt_server_event().

minigame_get_descriptor()

entity minigame_get_descriptor

(

string

id

)

Definition at line 5 of file minigames.qc.

{
    FOREACH(Minigames, it.netname == id, return it);
    return NULL;
}

References entity(), FOREACH, minigame_get_descriptor(), and NULL.

Referenced by HUD_MinigameBoard(), HUD_MinigameStatus(), minigame_get_descriptor(), and start_minigame().

minigame_get_owner()

entity minigame_get_owner

(

int

id

)

Definition at line 11 of file minigames.qc.

{
    entity e = NULL;
    while( (e = findfloat(e, minigame_id, id)) )
        if ( e.classname == "minigame" )
            return e;
    return NULL;
}

References entity(), findfloat(), minigame_id, and NULL.

Referenced by NET_HANDLE().

minigame_next_team()

int minigame_next_team	(	int	curr_team,
		int	n_teams )

Definition at line 74 of file minigames.qc.

{
    return curr_team % n_teams + 1;
}

Referenced by c4_move(), c4_server_event(), pp_move(), pp_server_event(), ttt_move(), and ttt_server_event().

minigame_prev_team()

int minigame_prev_team	(	int	curr_team,
		int	n_teams )

Definition at line 80 of file minigames.qc.

{
    return curr_team % n_teams - 1;
}

minigame_relative_tile()

string minigame_relative_tile	(	string	start_id,
		int	dx,
		int	dy,
		int	rows,
		int	columns )

Definition at line 49 of file minigames.qc.

{
    int letter = minigame_tile_letter(start_id);
    int number = minigame_tile_number(start_id);
    letter = (letter+dx) % columns;
    number = (number+dy) % rows;
    if ( letter < 0 )
        letter = columns + letter;
    if ( number < 0 )
        number = rows + number;
    return minigame_tile_buildname(letter, number);
}

References minigame_tile_buildname(), minigame_tile_letter(), minigame_tile_number(), and number.

minigame_server_sendflags()

void minigame_server_sendflags	(	entity	ent,
		int	mgflags )

Definition at line 87 of file minigames.qc.

{
    #ifdef SVQC
        ent.SendFlags |= mgflags;
    #endif
}

References entity().

Referenced by bd_activate_editor(), bd_check_winner(), bd_close_editor(), bd_controller_update(), bd_do_next_match(), bd_editor_place(), bd_load_piece(), bd_move(), bd_move_dozer(), bd_reset_moves(), bd_restart_match(), c4_move(), pp_move(), pp_next_match(), pp_setup_pieces(), ps_move(), ps_move_piece(), ps_setup_pieces(), ttt_move(), and ttt_next_match().

minigame_tile_buildname()

string minigame_tile_buildname	(	int	letter,
		int	number )

Definition at line 43 of file minigames.qc.

{
    return strcat(chr2str('a'+letter),ftos(number+1));
}

References chr2str, ftos(), number, and strcat().

Referenced by bd_fill_recurse(), bd_move_dozer(), bd_save_controller_piece(), bd_unfill_recurse(), c4_get_lowest_tile(), c4_winning_piece(), minigame_relative_tile(), minigame_tile_name(), nmm_spawn_tile_square(), nmm_tile_build_hmill(), nmm_tile_build_vmill(), pp_setup_pieces(), pp_valid_move(), pp_winning_piece(), ps_move(), ps_move_piece(), ps_setup_pieces(), ps_winning_piece(), and ttt_winning_piece().

minigame_tile_letter()

int minigame_tile_letter

(

string

id

)

Definition at line 21 of file minigames.qc.

{
    return str2chr(substring(id,0,1),0)-'a';
}

References str2chr, and substring().

Referenced by bd_do_fill(), bd_editor_place(), bd_load_piece(), bd_move_dozer(), bd_server_event(), bd_valid_tile(), c4_get_lowest_tile(), c4_valid_tile(), c4_winning_piece(), minigame_relative_tile(), minigame_tile_pos(), nmm_tile_adjacent(), nmm_tile_build_hmill(), nmm_tile_build_vmill(), pp_valid_move(), pp_valid_tile(), pp_winning_piece(), ps_move(), ps_tile_blacklisted(), ps_valid_tile(), ps_winning_piece(), ttt_valid_tile(), and ttt_winning_piece().

minigame_tile_name()

string minigame_tile_name	(	vector	pos,
		int	rows,
		int	columns )

Definition at line 63 of file minigames.qc.

{
    if ( pos_x < 0 || pos_x > 1 || pos_y < 0 || pos_y > 1 )
        return ""; // no tile
 
    int letter = floor(pos_x * columns);
    int number = floor((1-pos_y) * rows);
    return minigame_tile_buildname(letter, number);
}

References floor(), minigame_tile_buildname(), number, and vector.

minigame_tile_number()

int minigame_tile_number

(

string

id

)

Definition at line 30 of file minigames.qc.

{
    return stof(substring(id,1,-1)) -1 ;
}

References stof(), and substring().

Referenced by bd_do_fill(), bd_editor_place(), bd_load_piece(), bd_move_dozer(), bd_server_event(), bd_valid_tile(), c4_valid_tile(), c4_winning_piece(), minigame_relative_tile(), minigame_tile_pos(), nmm_tile_adjacent(), nmm_tile_build_hmill(), nmm_tile_build_vmill(), pp_valid_move(), pp_valid_tile(), pp_winning_piece(), ps_move(), ps_tile_blacklisted(), ps_valid_tile(), ps_winning_piece(), ttt_valid_tile(), and ttt_winning_piece().

minigame_tile_pos()

vector minigame_tile_pos	(	string	id,
		int	rows,
		int	columns )

Definition at line 36 of file minigames.qc.

{
    return vec2((minigame_tile_letter(id) + 0.5) / columns,
        (1 - (minigame_tile_number(id) + 0.5) / rows));
}

References minigame_tile_letter(), minigame_tile_number(), vec2, and vector.

Referenced by nmm_spawn_tile().

msle_classname()

string msle_classname

(

int

id

)

Definition at line 121 of file minigames.qc.

{
    if ( id == 1 ) return "minigame";
    if ( id == 2 ) return "minigame_player";
    int i = msle_base_id;
#define MSLE(Name, Fields) ++i; if ( id == i ) return #Name;
    MINIGAME_SIMPLELINKED_ENTITIES
#undef MSLE
    return "";
}

References MINIGAME_SIMPLELINKED_ENTITIES, and msle_base_id.

Referenced by NET_HANDLE().

msle_id()

int msle_id

(

string

class_name

)

Definition at line 110 of file minigames.qc.

{
    if ( class_name == "minigame" ) return 1;
    if ( class_name == "minigame_player" ) return 2;
    int i = msle_base_id;
#define MSLE(Name, Fields) ++i; if ( class_name == #Name ) return i;
    MINIGAME_SIMPLELINKED_ENTITIES
#undef MSLE
    return 0;
}

References MINIGAME_SIMPLELINKED_ENTITIES, and msle_base_id.

Referenced by minigame_SendEntity().

msle_spawn()

entity msle_spawn	(	entity	minigame_session,
		entity	e )

Definition at line 96 of file minigames.qc.

{
    e.owner = minigame_session;
    e.minigame_id = minigame_session.minigame_id;
    e.descriptor = minigame_session.descriptor;
    e.minigame_autoclean = 1;
    #ifdef SVQC
        setcefc(e, minigame_CheckSend);
        Net_LinkEntity(e, false, 0, minigame_SendEntity);
    #endif
    return e;
}

References entity(), minigame_CheckSend(), minigame_SendEntity(), Net_LinkEntity(), and setcefc.

Referenced by bd_editor_place(), bd_load_piece(), c4_move(), nmm_server_event(), pong_ai_spawn(), pong_paddle_spawn(), pong_server_event(), pp_move(), pp_setup_pieces(), ps_setup_pieces(), and ttt_move().

Variable Documentation

descriptor

entity descriptor

For minigame sessions: minigame descriptor object.

Definition at line 45 of file minigames.qh.

Referenced by bd_controller_send(), minigame_SendEntity(), and NET_HANDLE().

list_next

entity list_next

Definition at line 6 of file minigames.qh.

Referenced by HUD_MinigameMenu_Click_ExpandCollapse().

list_prev

entity list_prev

Definition at line 4 of file minigames.qh.

MINIG_SF_ALL

const int MINIG_SF_ALL = 0xff

Definition at line 116 of file minigames.qh.

Referenced by bd_load_piece(), c4_move(), minigame_resend(), pp_move(), pp_setup_pieces(), ps_move_piece(), ps_setup_pieces(), and ttt_move().

MINIG_SF_CREATE

const int MINIG_SF_CREATE = 0x01

Definition at line 112 of file minigames.qh.

Referenced by minigame_SendEntity(), and NET_HANDLE().

MINIG_SF_CUSTOM

const int MINIG_SF_CUSTOM = 0x10

Definition at line 114 of file minigames.qh.

MINIG_SF_MAX

const int MINIG_SF_MAX = 0x80

Definition at line 115 of file minigames.qh.

MINIG_SF_UPDATE

const int MINIG_SF_UPDATE = 0x02

Definition at line 113 of file minigames.qh.

Referenced by bd_activate_editor(), bd_check_winner(), bd_close_editor(), bd_do_next_match(), bd_editor_place(), bd_move(), bd_move_dozer(), bd_restart_match(), bd_server_event(), c4_move(), minigame_SendEntity(), NET_HANDLE(), nmm_server_event(), pong_ball_reset(), pong_ball_think(), pong_ball_throw(), pong_paddle_think(), pong_server_event(), pp_move(), pp_next_match(), pp_server_event(), pp_setup_pieces(), ps_move(), ps_setup_pieces(), ttt_move(), and ttt_next_match().

minigame_autoclean

bool minigame_autoclean

Definition at line 104 of file minigames.qh.

minigame_flags

int minigame_flags

Definition at line 107 of file minigames.qh.

Referenced by minigame_SendEntity(), and NET_HANDLE().

minigame_id

int minigame_id

Unique ID for the minigame session, associated with all objects currently the result of etof(minigame) on the server.

Definition at line 49 of file minigames.qh.

Referenced by bd_check_winner(), bd_controller_send(), bd_find_controller(), bd_find_dozer(), bd_find_piece(), bd_move(), bd_reset_moves(), bd_save_level(), bd_server_event(), bd_setup_pieces(), c4_find_piece(), c4_server_event(), deactivate_minigame(), end_minigame(), minigame_count_players(), minigame_get_owner(), minigame_resend(), minigame_SendEntity(), NET_HANDLE(), nmm_find_piece(), nmm_find_tile(), nmm_kill_tiles(), nmm_server_event(), nmm_tile_canmove(), pong_ai_think(), pp_find_piece(), pp_next_match(), pp_server_event(), ps_draw(), ps_find_piece(), ps_server_event(), ps_winning_piece(), ttt_find_piece(), ttt_next_match(), and ttt_server_event().