factionnpc plugin

Plugin hooks and methods

Part of FactionNPC

Main file of the FactionNPC plugin, which makes Half-Life 2 NPCs like or hate players according to the player's faction; exposes the plugin as factionnpc.

factionnpc.stored lists the NPC classes that side with the Combine or with the rebels, checked by factionnpc:IsNPCCombine and factionnpc:IsNPCRebel. factionnpc:UpdateNPCRelations and factionnpc:UpdateNPCRelation set the relationships, and the PlayerSpawn and PlayerSpawnedNPC hooks apply them.

Summary

Hooks

IsNPCCombine(npc)shared
Returns whether an NPC belongs to the Combine.
IsNPCRebel(npc)shared
Returns whether an NPC is on the rebels' side.
PlayerSpawn(ply)shared
Called when a player spawns; updates every NPC's relationship towards them.
PlayerSpawnedNPC(ply, npc)shared
Called after a player spawns an NPC; sets the new NPC's relationships towards all players.
UpdateNPCRelation(npc)shared
Sets how one NPC feels about every player, based on each player's faction.
UpdateNPCRelations(ply)shared
Sets how every NPC on the map feels about a player, based on the player's faction.

Hooks

factionnpc:IsNPCCombine(npc)

shared gamemodes/cwhl2rp/plugins/factionnpc/plugin/sh_plugin.lua:46

Returns whether an NPC belongs to the Combine.

Looks the NPC's class up in factionnpc.stored; floor turrets with the citizen spawn flag count as rebels.

Parameters

  • npc NPC The NPC to check

Returns

  • Boolean true for Combine NPC classes, false for anything else or an invalid entity

See also

factionnpc:IsNPCRebel(npc)

shared gamemodes/cwhl2rp/plugins/factionnpc/plugin/sh_plugin.lua:67

Returns whether an NPC is on the rebels' side.

True for classes marked false in factionnpc.stored (citizens, vortigaunts, Alyx and other resistance characters) and for floor turrets with the citizen spawn flag.

Parameters

  • npc NPC The NPC to check

Returns

  • Boolean true for rebel NPCs, false for anything else or an invalid entity

See also

factionnpc:PlayerSpawn(ply)

shared gamemodes/cwhl2rp/plugins/factionnpc/plugin/sh_plugin.lua:139

Called when a player spawns; updates every NPC's relationship towards them.

Parameters

  • ply Player The player who spawned

factionnpc:PlayerSpawnedNPC(ply, npc)

shared gamemodes/cwhl2rp/plugins/factionnpc/plugin/sh_plugin.lua:146

Called after a player spawns an NPC; sets the new NPC's relationships towards all players.

Parameters

  • ply Player The player who spawned the NPC
  • npc NPC The NPC that was spawned

factionnpc:UpdateNPCRelation(npc)

shared gamemodes/cwhl2rp/plugins/factionnpc/plugin/sh_plugin.lua:125

Sets how one NPC feels about every player, based on each player's faction.

Combine NPCs like Combine and admin faction players and hate everyone else; rebel NPCs hate Combine and admin faction players and like everyone else. Both hate the necro and antlion factions. Does nothing for NPCs that are neither Combine nor rebels.

Parameters

  • npc NPC The NPC whose relationships are set

See also

factionnpc:UpdateNPCRelations(ply)

shared gamemodes/cwhl2rp/plugins/factionnpc/plugin/sh_plugin.lua:104

Sets how every NPC on the map feels about a player, based on the player's faction.

Combine NPCs like Combine and admin faction players and hate everyone else; rebel NPCs hate Combine and admin faction players and like everyone else. Both hate the necro and antlion factions. Does nothing for an invalid entity or a non-player.

Parameters

  • ply Player The player the relationships are set towards

See also

Defined in