Table of Contents

Table of Contents

FlexScript Class - Agent.SocialForceState

Agent.SocialForceState

Description

Provides access to data and methods related to an agent's social force state.

This can be used in custom social force fields to get/set forces on the agent. It can also be used in other contexts to retrieve information about the current social forces acting upon the agent.

Properties

center The agent's current center point.
force The agent's current force.
friction The scalar value of the agent's current friction force. This is only applicable if the agent has a friction force applied.
goal The agent's current goal location.
hasGoal 1 if the agent currently has a goal, 0 otherwise.
velocity The agent's current velocity.

Details

Do no remove, this fixes the anchor on doc.flexsim.com

Agent.SocialForceState.center

readonly Vec3 center

Description

The agent's current center point.

Do no remove, this fixes the anchor on doc.flexsim.com

Agent.SocialForceState.force

Vec3 force

Description

The agent's current force.

You can only set this force as part of a custom social force.

Do no remove, this fixes the anchor on doc.flexsim.com

Agent.SocialForceState.friction

readonly double friction

Description

The scalar value of the agent's current friction force. This is only applicable if the agent has a friction force applied.

Do no remove, this fixes the anchor on doc.flexsim.com

Agent.SocialForceState.goal

readonly Vec3 goal

Description

The agent's current goal location.

Do no remove, this fixes the anchor on doc.flexsim.com

Agent.SocialForceState.hasGoal

readonly int hasGoal

Description

1 if the agent currently has a goal, 0 otherwise.

Do no remove, this fixes the anchor on doc.flexsim.com

Agent.SocialForceState.velocity

readonly Vec3 velocity

Description

The agent's current velocity.