Structure

Contains an information about the user entity and the directories of the following files:

• *.node - node reference file
• *.prop - property file
• *.h - entity logic file

Usage Example

<?xml version="1.0" encoding="utf-8"?>
<entity name="EntityActor">
    <description/>
    <node>framework/samples/platformer/entities/entity_actor/entity_actor.node</node>
    <logic>framework/samples/platformer/scripts/entities/entity_actor.h</logic>
    <property>framework/samples/platformer/entities/entity_actor/entity_actor.prop</property>
</entity>

Contains an information about the level and the directories of the following files:

• *.world - world file
• *.h - level logic file

Usage Example

<level name="level_1">
    <world>framework/samples/platformer/levels/level_1/level_1</world>
    <logic>framework/samples/platformer/scripts/levels/platformer_level.h</logic>
    <logic_class>PlatformerLevel</logic_class>
    <description/>
</level>

Contains an information about the the game and the directories of the following files:

• the list of all of the used *.entity files
• the list of all of the used *.level files
• *.prop - file containing the base property for all entities
• *.prop_list - file with the list of all the libraries required to load the game

<?xml version="1.0" encoding="utf-8"?>
<game version="0">
  <info>
    <name>platformer game</name>
    <developer/>
    <copyright/>
    <version/>
    <description/>
    <window_title/>
    <entity_property>framework/samples/platformer/entity.prop</entity_property>
    <properties>framework/samples/platformer/platformer_properties.prop_list</properties>
    <parameters>
      <parameter name="new_level_path">levels/%name/%name.level</parameter>
      <parameter name="new_level_logic_path">scripts/levels/%name/%name.h</parameter>
      <parameter name="new_level_world_path">levels/%name/%name.world</parameter>
      <parameter name="new_entity_path">entities/%name/%name.entity</parameter>
      <parameter name="new_entity_logic_path">scripts/entities/%name/%name.h</parameter>
      <parameter name="new_entity_node_path">entities/%name/%name.node</parameter>
      <parameter name="new_entity_property_path">entities/%name/%name.prop</parameter>
    </parameters>
  </info>
  <levels>
    <level name="level_1" level="framework/samples/platformer/levels/level_1/level_1.level"/>
    <level name="level_2" level="framework/samples/platformer/levels/level_2/level_2.level"/>
  </levels>
  <entities>
    <entity name="EntityActor" entity="framework/samples/platformer/entities/entity_actor/entity_actor.entity"/>
    <entity name="PlatformerActor" entity="framework/samples/platformer/entities/paltformer_actor/paltformer_actor.entity"/>
    <entity name="Hero" entity="framework/samples/platformer/entities/hero/hero.entity"/>
    <entity name="Monster" entity="framework/samples/platformer/entities/monster/monster.entity"/>
    <entity name="DeadZone" entity="framework/samples/platformer/entities/dead_zone/dead_zone.entity"/>
    <entity name="EndLevel" entity="framework/samples/platformer/entities/end_level/end_level.entity"/>
    <entity name="MonsterBoss" entity="framework/samples/platformer/entities/monster_boss/monster_boss.entity"/>
    <entity name="Bonus" entity="framework/samples/platformer/entities/bonus/bonus.entity"/>
  </entities>
</game>

Game Framework Editor can also be used to create and edit these files.

*.prop and *.prop_list files are automatically generated by the Game Framework Editor plugin.

Engine analyzes all the classes inherited from the Entity class and based on the user class function attributes generate the parameter for the property. Such functions are called "Fields" and require both set() and get() methods to be specified.

Every time the user Entity class instance is created, the Field set() methods are called automatically to pass the relevant parameter from the property with the user set value.

The types of the Fields are listed below.

A parameter of the integer type.

Attributes:

• [get_int:field_name] - getter
• [set_int:field_name] - setter

Usage Example

[get_int:my int parameter]
int getMyParameter() {
  return 0;
}

[set_int:my int parameter]
void setMyParameter(int v) {
  // do something
}

A parameter of the float type.

Attributes:

• [get_float:field_name] - getter
• [set_float:field_name] - setter

Usage Example

[get_float:my float parameter]
float getMyParameter() {
  return 0.0f;
}

[set_float:my float parameter]
void setMyParameter(float v) {
  // do something
}

A parameter of the double type.

Attributes:

• [get_double:field_name] - getter
• [set_double:field_name] - setter

Usage Example

[get_double:my double parameter]
double getMyParameter() {
  return 0.0;
}

[set_double:my double parameter]
void setMyParameter(double v) {
  // do something
}

A parameter of the vec3 type.

Attributes:

• [get_vec3:field_name] - getter
• [set_vec3:field_name] - setter

Usage Example

[get_vec3:my vec3 parameter]
vec3 getMyParameter() {
  return vec3(0.0f,0.0f,0.0f);
}

[set_vec3:my vec3 parameter]
void setMyParameter(vec3 v) {
  // do something
}

A parameter of the vec4 type.

Attributes:

• [get_vec4:field_name] - getter
• [set_vec4:field_name] - setter

Usage Example

[get_vec4:my vec4 parameter]
vec4 getMyParameter() {
  return vec4(0.0f,0.0f,0.0f,0.0f);
}

[set_vec4:my vec4 parameter]
void setMyParameter(vec4 v) {
  // do something
}

A parameter of the string type.

Attributes:

• [get_string:field_name] - getter
• [set_string:field_name] - setter

Usage Example

[get_string:my string parameter]
string getMyParameter() {
  return “my_string”;
}

[set_string:my string parameter]
void setMyParameter(string v) {
  // do something
}

A parameter of the color type.

Attributes:

• [get_color:field_name] - getter
• [set_color:field_name] - setter

Usage Example

[get_color:my color parameter]
vec4 getMyParameter() {
  return vec4(1.0f,1.0f,1.0f,1.0f);
}

[set_color:my color parameter]
void setMyParameter(vec4 v) {
  // do something
}

A parameter of the toggle type.

Attributes:

• [get_toggle:field_name] - getter
• [set_toggle:field_name] - setter

Usage Example

[get_toggle:my toggle parameter]
int getMyParameter() {
  return 0;
}

[set_toggle:my toggle parameter]
void setMyParameter(int v) {
  // do something
}

A parameter of the switch type.

Attributes:

• [get_switch:field_name] - getter
• [set_switch:field_name] - setter

Usage Example

[get_switch:my switch:”one,two,three”]
int getMyParameter() {
  return 0;
}

[set_switch:my switch]
void setMyParameter(int v) {
  // do something
}

A parameter of the file type. Identical to the parameter of the string type, but having an icon to open a file selection window.

Attributes:

• [get_file:field_name] - getter
• [set_file:field_name] - setter

Usage Example

[get_file:my file:”one,two,three”]
int getMyParameter() {
  return 0;
}

[set_file:my file]
void setMyParameter(int v) {
  // do something
}

A parameter of the mask type. To modify this kind of the parameter in Editor you need to double click to it. In the opened dialog window you can define the mask.

Attributes:

• [get_mask:field_name] - getter
• [set_mask:field_name] - setter

Usage Example

[get_mask:"Mask field"]
int getMaskField() {
  return mask_field;
}


[set_mask:"Mask field"]
void setMaskField(int value) {
  mask_field = value;
}

int, float, double, string, vec3, vec4, dvec3 and dvec4 field types can be identified automatically. Instead of direct specification (e.g. [get_int] or [set_int]), you can specify just an attribute name (e.g. [get:”field_name”]). Editor will automatically identify the type of the parameter (for "get" functions), or a type of argument (for "set" functions).

For example, we need to create a field of the integer type:

[set:"Damage"] 
void setDamage(int value) {
  damage = value;
}

[get:"Damage"] 
int getDamage() {
  return damage;
}