$bodygroup: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(bah)
(redone)
Line 1: Line 1:
''Body Groups'' are sub-meshes of a model that can have changeable states. Server code can change the state of a model's body groups.
'''$bodygroup''' is a [[QC command]] that defines a group of meshes that can be turned on or off. Server code can change their state.


== Syntax ==
{{note|Bodygroups cannot change [[skeleton]]s or [[collision model]]s.}}
To define a body groups, you need to add lines in the [[.qc]]:


$bodygroup (name)
== Example ==
{
studio (modelname)
["studio" modelname]
[blank]
}


== Examples ==
<source lang=php>
$bodygroup sights
{
studio "ironsights.smd"
studio "laser_dot.smd"
blank
}
</source>


A single .mdl could be used for characters with and without glasses:
This bodygroup allows a weapon to have iron sights, laser sights, or no sights at all.


$bodygroup studio
<source lang=php>
{
$bodygroup chest
studio "dude.smd"
{
}
studio "chest_with_no_armor.smd"
studio "chest_with_light_armor.smd"
$bodygroup eyewear
studio "chest_with_heavy_armor.smd"
{
studio "chest_with_super_armor.smd"
studio "glasses.smd"
}
blank
</source>
}


This example has two body groups numbered 0 and 1. Group 0 uses a single mesh and group 1 uses 2, a model of a pair of glasses (state 0) and the built-in "no-polygons" model (state 1) which is used to "turn-off" the glasses.
This bodygroup defines the entire chest region of the model, which probably spans multiple bones.


=== Multiple sets ===
{{note|Since polygons never share vertices in Source models, there need not be seams between properly-made components.}}
You can have multiple entries in a bodygroup, for example you could have 4 different sets of the chest, each with different styles:


$bodygroup chest
== Programming ==
{
studio "chest_with_no_armor.smd"
studio "chest_with_light_armor.smd"
studio "chest_with_heavy_armor.smd"
studio "chest_with_super_armor.smd"
}


You could also just put the armor pieces in their own group and always draw the underlying chest without armor, but it's less efficient and often there's no clean "base" set, such as if you're using bodygroups to define multiple heads.
To change a body group's state:


The models used in bodygroups can span any number of bones.
<source lang=cpp>
static int BodyGroup_Sights = FindBodygroupByName("sights"); // calculate this value once
SetBodygroup( BodyGroup_Sights , 1 ); // laser dot
</source>


== Switching groups in code ==
By default, <code>[[CBaseAnimating]]</code> supports 4,294,967,296 combinations (32 bits), and <code>[[CBaseViewModel]]</code> supports 256 (8 bits). You can raise either of these by editing the relevant [[SendProp]] for <code>m_nBody</code>.


To change a body group's state call <code>CBaseAnimating::SetBodygroup( int iGroup, int iValue )</code> in server code. For example, this would randomly give 1 out of 5 characters glasses:
To calculate how many combinations you need, multiply the size of all your bodygroups together. The examples on this page total 3 * 4 = 12...but add two more groups the same size and you're up at 144. The figure grows exponentially.
 
SetBodygroup( 1, ( RandomInt( 1, 5 ) == 1 )?1:0 );
 
Bodygroups are limited to 32 bits of combinations, which is a total of 4,294,967,296 combinations.  If you used the above eyewear and chest examples, the total combinations would be eyewear x chest, or 2 x 4, or a total of 8 combinations. Just multiply all your bodygroup combinations together to make sure your total is less than the max.  Weapons by default are limited to 256 combinations, though it's just a network limit which is easy for your mod to change. See:
 
BEGIN_NETWORK_TABLE_NOBASE(CBaseViewModel, DT_BaseViewModel)
...
<b>SendPropInt (SENDINFO(m_nBody), 8),</b>
 
==See also==
* [[Multiple_Skins_for_a_Single_Model | Skins]]
* DOD Player Models make extensive use of Bodygroups.


[[Category:Modeling]]
[[Category:Modeling]]

Revision as of 05:03, 31 December 2010

$bodygroup is a QC command that defines a group of meshes that can be turned on or off. Server code can change their state.

Note.pngNote:Bodygroups cannot change skeletons or collision models.

Example

$bodygroup sights
{
	studio "ironsights.smd"
	studio "laser_dot.smd"
	blank
}

This bodygroup allows a weapon to have iron sights, laser sights, or no sights at all. 

$bodygroup chest
{
	studio "chest_with_no_armor.smd"
	studio "chest_with_light_armor.smd"
	studio "chest_with_heavy_armor.smd"
	studio "chest_with_super_armor.smd"
}

This bodygroup defines the entire chest region of the model, which probably spans multiple bones.

Note.pngNote:Since polygons never share vertices in Source models, there need not be seams between properly-made components.

Programming

To change a body group's state: 

static int BodyGroup_Sights = FindBodygroupByName("sights"); // calculate this value once
SetBodygroup( BodyGroup_Sights , 1 ); // laser dot

By default, CBaseAnimating supports 4,294,967,296 combinations (32 bits), and CBaseViewModel supports 256 (8 bits). You can raise either of these by editing the relevant SendProp for m_nBody.

To calculate how many combinations you need, multiply the size of all your bodygroups together. The examples on this page total 3 * 4 = 12...but add two more groups the same size and you're up at 144. The figure grows exponentially.

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=$bodygroup&oldid=141149"